Get all subscriptions data
Response Params
URL Parameters | Type | Description |
|---|---|---|
id | text | Customer id |
customer_id | text | Ecommerce customer id |
status | enum | "Active" = subscription’s running state |
plan | object | The plan which is subscribed to |
order_payload | object | The order payload to be passed to create order |
payment | object | The payment detail of the subscription |
payment_link_activity | object | The payment link details when the subscription is in halted state |
orders | object | All the order of the subscription |
subscribed_at | datetime | The subscription starting date |
last_renewal | datetime | The subscription’s previous renewed date |
next_renewal | datetime | The subscription’s next renewal date |
renews_left | number | The subscription’s auto expiry count |
address | object | Shipping address of the subscription |
cancellation | object | Cancel details of the subscription |
created_at | datetime | Plan created date |
updated_at | datetime | Plan recent updated date |
order_payload [line_items][line_items] | object | Ecommerce order payload |
order_payload [shipping_line][shipping_line] | object | shipping details of ecommerce if exist |
order_payload [note] | text | order note for the ecommerce order |
order_payload [note_attributes][note_attributes] | object | order attributes for the ecommerce order |
payment [gateway] | text | Payment gateway name |
payment [payment_mode][payment_mode] | text | Payment mode detail |
payment [recurring] | boolean | Recurring debit eligibility for the payment |
payment_link_activity [url] | text | Subscription renewal link |
payment_link_activity [clicks] | number | Number of times the link has been accessed |
payment_link_activity [status] | text | "Issued" = on generating the link, "Paid" = on successful renewal |
address[first_name][first_name] | text | Customer first name |
address[last_name][last_name] | text | Customer last name |
address[address1] | text | Customer address |
address[city] | text | Customer city |
address[province] | text | Customer province |
address[zip] | text | Customer zip |
address[phone] | text | Customer phone |
address[country] | text | Customer country |
cancellation[status] | boolean | The status whether subscription is cancelled or not |
cancellation[cancelled_at][cancelled_at] | datetime | Subscription cancelled date |
cancellation[cancelled_reason][cancelled_reason] | text | Subscription cancelled reason |