Subscriptions charge a customer on a recurring basis. Subscriptions are a contract by an organization to provide services to a customer. A subscription sets the top level attributes for the contract if it’s active, when it starts and ends, trial dates and its currency.Documentation Index
Fetch the complete documentation index at: https://docs.valued.app/llms.txt
Use this file to discover all available pages before exploring further.
The subscription model
Subscriptions let customers make recurring payments to use your product in a certain way. Each subscription has a status that can change over time, a currency and properties to specify it’s duration and it’s trial.Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier for the object |
status | string | Yes | Status of the subscription. Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid. |
currency | currency | Yes | Three-letter ISO-4271 currency code. |
started_at | timestamp | Yes | Unix epoch time the subscription was started |
canceled_at | timestamp | No | Unix epoch time the subscription was canceled |
trial_start_at | timestamp | No | When applicable, Unix epoch time the trial began |
trial_end_at | timestamp | No | When applicable, Unix epoch timethe trial ended at |
period_end | timestamp | Yes | Unix epoch time of the end of the period the subscription has been invoiced for |
ended_at | timestamp | No | Unix epoch time the subscription ends |