subscription.active

Core API

Checkout
Checkout Links
Custom Checkout Fields
Customers
Subscriptions
Orders
Discounts
Refunds
Products
Benefits
License Keys
Files
Organizations
Metrics

Customer Portal API

GET
Get Customer
GET
Get Organization
Sessions
Subscriptions
Orders
License Keys
File Downloads

Webhook Events

Customer Events
Billing Events
- Checkout
- Subscriptions
- Orders
- Refunds
- Benefit Grants
Organization Events

OAuth 2.0 API

Connect
Clients

Sent when a subscription becomes active, whether because it's a new paid subscription or because payment was recovered.

Discord & Slack support: Full

type

string

required

Allowed value: "subscription.active"

Example:

"subscription.active"

data

object

required

data.created_at

string

required

Creation timestamp of the object.

data.modified_at

string | null

required

Last modification timestamp of the object.

data.id

string

required

The ID of the object.

data.amount

integer

required

The amount of the subscription.

data.currency

string

required

The currency of the subscription.

data.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

data.status

enum<string>

required

The status of the subscription.

Available options:

incomplete,

incomplete_expired,

trialing,

active,

past_due,

canceled,

unpaid

data.current_period_start

string

required

The start timestamp of the current billing period.

data.current_period_end

string | null

required

The end timestamp of the current billing period.

data.cancel_at_period_end

boolean

required

Whether the subscription will be canceled at the end of the current period.

data.canceled_at

string | null

required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

data.started_at

string | null

required

The timestamp when the subscription started.

data.ends_at

string | null

required

The timestamp when the subscription will end.

data.ended_at

string | null

required

The timestamp when the subscription ended.

data.customer_id

string

required

The ID of the subscribed customer.

data.product_id

string

required

The ID of the subscribed product.

data.discount_id

string | null

required

The ID of the applied discount, if any.

data.checkout_id

string | null

required

data.customer_cancellation_reason

enum<string> | null

required

Available options:

customer_service,

low_quality,

missing_features,

switched_service,

too_complex,

too_expensive,

unused,

other

data.customer_cancellation_comment

string | null

required

data.price_id

string

requireddeprecated

data.metadata

object

required

data.customer

object

required

data.customer.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

data.customer.created_at

string

required

Creation timestamp of the object.

data.customer.modified_at

string | null

required

Last modification timestamp of the object.

data.customer.metadata

object

required

data.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

data.customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

data.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

data.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

data.customer.billing_address

object | null

required

data.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

data.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

data.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

data.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

data.user_id

string

requireddeprecated

data.user

object

requireddeprecated

data.product

object

required

A product.

data.product.created_at

string

required

Creation timestamp of the object.

data.product.modified_at

string | null

required

Last modification timestamp of the object.

data.product.id

string

required

The ID of the product.

data.product.name

string

required

The name of the product.

data.product.description

string | null

required

The description of the product.

data.product.recurring_interval

enum<string> | null

required

The recurring interval of the product. If None, the product is a one-time purchase.

Available options:

month,

year

data.product.is_recurring

boolean

required

Whether the product is a subscription.

data.product.is_archived

boolean

required

Whether the product is archived and no longer available.

data.product.organization_id

string

required

The ID of the organization owning the product.

data.product.metadata

object

required

data.product.prices

object[]

required

List of prices for this product.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

data.product.benefits

object[]

required

List of benefits granted by the product.

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

data.product.medias

object[]

required

List of medias associated to the product.

File to be used as a product media file.

data.product.attached_custom_fields

object[]

required

List of custom fields attached to the product.

Schema of a custom field attached to a resource.

data.discount

object | null

required

data.price

object

requireddeprecated

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

data.prices

object[]

required

List of enabled prices for the subscription.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

data.custom_field_data

object

Key-value object storing custom field values.

Was this page helpful?

subscription.created

subscription.updated

{
  "type": "subscription.active",
  "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>",
    "discount_id": "<string>",
    "checkout_id": "<string>",
    "customer_cancellation_reason": "customer_service",
    "customer_cancellation_comment": "<string>",
    "price_id": "<string>",
    "metadata": {},
    "custom_field_data": {},
    "customer": {
      "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "customer@example.com",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "tax_id": [
        "911144442",
        "us_ein"
      ],
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "deleted_at": "2023-11-07T05:31:56Z",
      "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
    },
    "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": {
            "note": "<string>"
          },
          "is_tax_applicable": true
        }
      ],
      "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            "properties": {
              "form_label": "<string>",
              "form_help_text": "<string>",
              "form_placeholder": "<string>",
              "textarea": true,
              "min_length": 1,
              "max_length": 1
            }
          },
          "order": 123,
          "required": 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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
    },
    "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
    },
    "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
      }
    ]
  }
}