Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Benefits
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Billing Events
- Checkout
- Subscriptions
- Orders
- Refunds
- Benefit Grants
- Organization Events
OAuth 2.0 API
- Connect
- Clients
subscription.created
Sent when a new subscription is created.
Discord & Slack support: Full
"subscription.created"Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
month, year incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid customer_service, low_quality, missing_features, switched_service, too_complex, too_expensive, unused, other Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
A product.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the product.
The name of the product.
The description of the product.
The recurring interval of the product. If None, the product is a one-time purchase.
month, year Whether the product is a subscription.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
List of prices for this product.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the price.
"fixed"Whether the price is archived and no longer available.
The ID of the product owning the price.
The type of the price.
"recurring"The recurring interval of the price.
month, year The currency.
The price in cents.
List of benefits granted by the product.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the benefit.
"ads"The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
The ID of the organization owning the benefit.
List of medias associated to the product.
The ID of the object.
"product_media"List of custom fields attached to the product.
ID of the custom field.
Schema for a custom field of type text.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"text"Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
Order of the custom field in the resource.
Whether the value is required for this custom field.
A recurring price for a product, i.e. a subscription.
Deprecated: The recurring interval should be set on the product itself.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the price.
"fixed"Whether the price is archived and no longer available.
The ID of the product owning the price.
The type of the price.
"recurring"The recurring interval of the price.
month, year The currency.
The price in cents.
once, forever, repeating fixed, percentage Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Name of the discount. Will be displayed to the customer when the discount is applied.
Code customers can use to apply the discount during checkout.
Timestamp after which the discount is redeemable.
Timestamp after which the discount is no longer redeemable.
Maximum number of times the discount can be redeemed.
Number of times the discount has been redeemed.
The organization ID.
Was this page helpful?
{
"type": "<string>",
"data": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount": 123,
"currency": "<string>",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"discount_id": "<string>",
"checkout_id": "<string>",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "<string>",
"metadata": {},
"custom_field_data": {},
"customer": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"email": "<string>",
"email_verified": true,
"name": "<string>",
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"tax_id": [
"<any>"
],
"organization_id": "<string>",
"avatar_url": "<string>"
},
"user_id": "<string>",
"user": {
"id": "<string>",
"email": "<string>",
"public_name": "<string>",
"avatar_url": "<string>",
"github_username": "<string>"
},
"product": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>",
"metadata": {},
"prices": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "month",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
}
],
"benefits": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"type": "<string>",
"description": "<string>",
"selectable": true,
"deletable": true,
"organization_id": "<string>",
"properties": {
"image_height": 400,
"image_width": 400
}
}
],
"medias": [
{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"path": "<string>",
"mime_type": "<string>",
"size": 123,
"storage_version": "<string>",
"checksum_etag": "<string>",
"checksum_sha256_base64": "<string>",
"checksum_sha256_hex": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"version": "<string>",
"service": "<string>",
"is_uploaded": true,
"created_at": "2023-11-07T05:31:56Z",
"size_readable": "<string>",
"public_url": "<string>"
}
],
"attached_custom_fields": [
{
"custom_field_id": "<string>",
"custom_field": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"type": "<string>",
"slug": "<string>",
"name": "<string>",
"organization_id": "<string>",
"properties": {
"form_label": "<string>",
"form_help_text": "<string>",
"form_placeholder": "<string>",
"textarea": true,
"min_length": 1,
"max_length": 1
}
},
"order": 123,
"required": true
}
]
},
"price": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "month",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 123,
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"name": "<string>",
"code": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"max_redemptions": 123,
"redemptions_count": 123,
"organization_id": "<string>"
}
}
}