List subscriptions

GET

/api/v1/subscriptions

const url = 'https://digize.com/api/v1/subscriptions';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/subscriptions \
  --header 'x-api-key: <x-api-key>'

Subscriptions started from payment links, the newest first, with their status and next charge.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

stripeId

required

string

contact

required

object

required

The contact’s id.

string

name

required

string

email

required

string

plan

required

string

interval

required

“Monthly”, “Every 2 weeks”.

string

intervalDays

required

number

amount

required

In the workspace currency’s minor unit: 2000 is $20.00.

integer

<= 100000000

status

required

string

Allowed values: active paused past_due canceled

startedAt

required

string format: date-time

nextChargeAt

required

Any of:

string
null

string format: date-time

pausedUntil

required

Any of:

string
null

string format: date-time

canceledAt

required

Any of:

string
null

string format: date-time

charges

required

Successful charges so far.

number

total

required

number

Example

{
  "rows": [
    {
      "status": "active"
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}