Subscription Object

Attributes
id string
A unique identifier for the subscription.
﻿
object string
The value is always subscription.
﻿
next_billing_date timestamp
The upcoming billing date of the subscription. Available for subscriptions with status active, past due and trialing.
﻿
cancellation_date timestamp
The date the subscription was cancelled. Available for subscriptions with status cancelled.
﻿
resumes_at timestamp
The date the payment collection of the subscription will be resumed. Available for subscriptions with status paused.
﻿
completion_date timestamp
The date the instalment plan was completed. Available for subscriptions with type instalment.
﻿
payment_count integer
The total number of payments received for the subscription.
﻿
status string
The current status of the subscription.
﻿
gateway_subscription_id string
The unique id of the subscription used by the payment provider.
﻿
type string
The possible values are instalment, subscription and recurring_invoice.
﻿
gateway string payment code﻿
The payment method of the subscription.
﻿
billing_cycle string
The possible values are day, week, month and year.
﻿
interval integer
The billing interval of the subscription.
﻿
currency string
The currency of the subscription.
﻿
price integer
The cost of the subscription.
﻿
invoice_id string
The id of the invoice associated with the subscription. Available for subscriptions with type instalment.
﻿
instalments_count integer
The total number of payments that have to be collected for this instalment plan. Available for subscriptions with type instalment.
﻿
lifetime_revenue integer
The total lifetime revenue generated by the subscription.
﻿
upcoming_invoice Invoice Object﻿
The upcoming invoice of the subscription. Provided if the subscription the subscription is active or trialing.
﻿
customer object
An object containing a few basic information about the customer.
JSON
"customer": {
    "id": "72b51cc1-613a-4189-a395-d5161b8a16c2",
    "name": "John",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "locale": "en",
    "client_id": null,
    "address_id": "21d10711-4ed0-4f51-ad58-f7fa72d79d25"
}
"customer": {
    "id": "72b51cc1-613a-4189-a395-d5161b8a16c2",
    "name": "John",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "locale": "en",
    "client_id": null,
    "address_id": "21d10711-4ed0-4f51-ad58-f7fa72d79d25"
}
﻿
id string
The customer id.
name string
The name of the customer.
last_name string
The customer's last name.
email string
The customer's email.
locale string (Language Codes﻿)
The preferred language of the customer.
client_id string
The id of the associated client (if applicable). 
﻿
products array of objects
An array of objects, each corresponding to a billing plan associated with the subscription.
JSON
"products": [
  {
    "id": "619b5981-c097-4eb8-890b-5166b30880fd",
    "name": "Subscription with Trial"
  }
]
"products": [
  {
    "id": "619b5981-c097-4eb8-890b-5166b30880fd",
    "name": "Subscription with Trial"
  }
]
﻿
id string
The id of the product (if applicable).
name string
The name of the product.
/
Subscription Object Example
View
﻿
﻿
﻿
Subscriptions
Pause Subscription