Description
A subscription represents a purchased offering related to a business. It includes details such as the buyer, pricing, trial period, and the subscription's lifecycle state.
Properties
| Name | Description | Type | Example |
|---|---|---|---|
| uid | The unique identifier of the subscription | string | c33f32c-95ae-4e8f-9f65-18bba589cb43 |
| created_at | The creation date and time of the subscription | string | 2024-01-01T09:00:00Z |
| updated_at | The last updated date and time of the subscription | string | 2024-03-20T12:34:56Z |
| display_name | The subscription display name | string | Premium 10 |
| is_active | Indicates if the subscription is active (not canceled or expired) | boolean | true |
| offering_uid | The UID of the underlying directory offering | string | bc33f12d-98ee-428f-9f65-18bba589cb95 |
| purchase_state | The current state of the subscription (suspended, purchased, canceled, expired) | string | purchased |
| cancellation_date | The date the subscription was canceled | string | "" |
| expiration_date | The date the subscription expired | string | "" |
| buyer_uid | The UID of the staff who purchased the subscription | string | user_12345 |
| business_uid | The UID of the business the subscription is related to | string | biz_67890 |
| purchase_price | The price of the subscription at the time of purchase | number | 99.99 |
| purchase_currency | The currency of the subscription purchase (USD, EUR, GBP) | string | USD |
| payment_type | The payment type of the subscription (monthly, annual, free, single_charge, bundle) | string | monthly |
| bundled_from_subscription_uid | The UID of the subscription this subscription is bundled from | string | "" |
| charged_by | Indicates who charges for the subscription (partner, inTandem, direct_recurly, SBTPG_recurly) | string | inTandem |
| enable_trial | Indicates if the subscription includes a trial period | boolean | true |
| trial_type | How the trial period is managed (automatic_charge, manual_charge, expire) | string | automatic_charge |
| trial_period | The number of days in the trial period | number | 14 |
| is_in_trial_period | Indicates if the subscription is currently in the trial period | boolean | false |
Example
{
"uid": "c33f32c-95ae-4e8f-9f65-18bba589cb43",
"created_at": "2024-01-01T09:00:00Z",
"updated_at": "2024-03-20T12:34:56Z",
"display_name": "Premium 10",
"is_active": true,
"offering_uid": "bc33f12d-98ee-428f-9f65-18bba589cb95",
"purchase_state": "purchased",
"cancellation_date": "",
"expiration_date": "",
"buyer_uid": "user_12345",
"business_uid": "biz_67890",
"purchase_price": 99.99,
"purchase_currency": "USD",
"payment_type": "monthly",
"bundled_from_subscription_uid": "",
"charged_by": "inTandem",
"enable_trial": true,
"trial_type": "automatic_charge",
"trial_period": 14,
"is_in_trial_period": false
}