Retrieve a rate card subscription v2

Retrieve a RateCardSubscription by ID.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
The ID of the RateCardSubscription to retrieve.

Returns

Response attributes

idstring
The ID of the RateCardSubscription.

objectstring, value is "v2.billing.rate_card_subscription"
String representing the object’s type. Objects of the same type share the same value of the object field.

billing_cadencestring
The ID of the billing Cadence.

collection_statusnullable enum

The payment status of a RateCardSubscription.

Possible enum values

awaiting_customer_action

The subscription payment is pending and requires customer action.

current

The subscription is in good standing. All payments have been successfully processed.

past_due

The subscription is currently overdue for payment. We are actively attempting to process the payment.

paused

Payment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.

unpaid

All attempts to collect payment for the subscription have been unsuccessful, and the outstanding balance is marked as uncollectible.

collection_status_transitionsnullable object
The collection status transitions of the RateCardSubscription.

createdtimestamp
Timestamp of when the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

rate_cardstring
The ID of the RateCard.

rate_card_versionstring
The ID of the RateCardVersion.

servicing_statusnullable enum

The servicing status of a RateCardSubscription.

Possible enum values

active

The provisionee of this subscription is receiving servicing.

canceled

Servicing for this subscription is canceled.

paused

The servicing for the provisionee of this subscription is paused.

pending

The subscription is pending a successful payment and is not being serviced yet.

servicing_status_transitionsnullable object
The servicing status transitions of the RateCardSubscription.

test_clocknullable string
The ID of the Test Clock, if any.

Error Codes

404rate_card_subscription_not_found

Returned when a RateCardSubscription by the provided ID cannot be found.

GET /v2/billing/rate_card_subscriptions/:id

Server-side language

curl https://api.stripe.com/v2/billing/rate_card_subscriptions/rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "id": "rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM",
  "object": "v2.billing.rate_card_subscription",
  "billing_cadence": "bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie",
  "metadata": {},
  "rate_card": "rcd_test_61Rc0EnUkb3UIaPVQ16RM8VQESSQ4t1K5KYFAmKUSUCG",
  "rate_card_version": "rcdv_test_61Rc0EnbIs6eHyCWW16RM8VQESSQ4t1K5KYFAmKUS2Nk",
  "collection_status": "current",
  "servicing_status": "active",
  "created": "2024-11-26T16:33:03.000Z",
  "livemode": false
}

List rate card subscriptions v2

List all RateCardSubscription objects.

Learn more about calling API v2 endpoints.

Parameters

billing_cadencestring
Optionally filter by a BillingCadence. Mutually exclusive with payers, rate_card, and rate_card_version.

limitinteger
The page size limit, if not provided the default is 20.

pagestring
The pagination token.

payerobject
Optionally filter by the payer associated with Cadences which the RateCardSubscriptions are subscribed to. Mutually exclusive with billing_cadence, rate_card, and rate_card_version.

rate_cardstring
Optionally filter by a RateCard. Mutually exclusive with billing_cadence, payers, and rate_card_version.

rate_card_versionstring
Optionally filter by a RateCard version. Mutually exclusive with billing_cadence, payers, and rate_card.

servicing_statusenum

Optionally filter by servicing status.

Possible enum values

active

The provisionee of this subscription is receiving servicing.

canceled

Servicing for this subscription is canceled.

paused

The servicing for the provisionee of this subscription is paused.

pending

The subscription is pending a successful payment and is not being serviced yet.

Returns

Response attributes

dataarray of objects
The retrieved RateCardSubscriptions.

next_page_urlnullable string
The URL to retrieve the next page if there are more RateCardSubscriptions to retrieve.

previous_page_urlnullable string
The URL to retrieve the previous page if this is not the first page.

Error Codes

404billing_cadence_not_found

Returned when the provided billing_cadence ID cannot be found.

404customer_not_found

Returned when the customer for the provided ID cannot be found.

404rate_card_not_found

Returned when the provided rate_card ID cannot be found.

404rate_card_subscription_not_found

Returned when a RateCardSubscription by the provided ID cannot be found.

404rate_card_version_not_found

Returned when the provided rate_card_version ID cannot be found.

GET /v2/billing/rate_card_subscriptions

Server-side language

curl https://api.stripe.com/v2/billing/rate_card_subscriptions \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "data": [
    {
      "id": "rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM",
      "object": "v2.billing.rate_card_subscription",
      "billing_cadence": "bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie",
      "metadata": {},
      "rate_card": "rcd_test_61Rc0EnUkb3UIaPVQ16RM8VQESSQ4t1K5KYFAmKUSUCG",
      "rate_card_version": "rcdv_test_61Rc0EnbIs6eHyCWW16RM8VQESSQ4t1K5KYFAmKUS2Nk",
      "collection_status": "current",
      "servicing_status": "active",
      "created": "2024-11-26T16:33:03.000Z",
      "livemode": true
    }
  ]
}

Cancel a rate card subscription v2

Cancel an existing, active RateCardSubscription.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
The ID of the RateCardSubscription to cancel.

Returns

Response attributes

idstring
The ID of the RateCardSubscription.

objectstring, value is "v2.billing.rate_card_subscription"
String representing the object’s type. Objects of the same type share the same value of the object field.

billing_cadencestring
The ID of the billing Cadence.

collection_statusnullable enum

The payment status of a RateCardSubscription.

Possible enum values

awaiting_customer_action

The subscription payment is pending and requires customer action.

current

The subscription is in good standing. All payments have been successfully processed.

past_due

The subscription is currently overdue for payment. We are actively attempting to process the payment.

paused

Payment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.

unpaid

All attempts to collect payment for the subscription have been unsuccessful, and the outstanding balance is marked as uncollectible.

collection_status_transitionsnullable object
The collection status transitions of the RateCardSubscription.

createdtimestamp
Timestamp of when the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

rate_cardstring
The ID of the RateCard.

rate_card_versionstring
The ID of the RateCardVersion.

servicing_statusnullable enum

The servicing status of a RateCardSubscription.

Possible enum values

active

The provisionee of this subscription is receiving servicing.

canceled

Servicing for this subscription is canceled.

paused

The servicing for the provisionee of this subscription is paused.

pending

The subscription is pending a successful payment and is not being serviced yet.

servicing_status_transitionsnullable object
The servicing status transitions of the RateCardSubscription.

test_clocknullable string
The ID of the Test Clock, if any.

Error Codes

400invalid_rate_card_subscription_status_for_cancel

Returned when the Cancel RateCardSubscription RPC is called with a status=canceled RateCardSubscription.

404rate_card_subscription_not_found

Returned when a RateCardSubscription by the provided ID cannot be found.

POST /v2/billing/rate_card_subscriptions/:id/cancel

Server-side language

curl -X POST https://api.stripe.com/v2/billing/rate_card_subscriptions/rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM/cancel \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview"

Response

{
  "id": "rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM",
  "object": "v2.billing.rate_card_subscription",
  "billing_cadence": "bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie",
  "metadata": {},
  "rate_card": "rcd_test_61Rc0EnUkb3UIaPVQ16RM8VQESSQ4t1K5KYFAmKUSUCG",
  "rate_card_version": "rcdv_test_61Rc0EnbIs6eHyCWW16RM8VQESSQ4t1K5KYFAmKUS2Nk",
  "collection_status": "current",
  "servicing_status": "canceled",
  "created": "2024-11-26T16:33:03.000Z",
  "livemode": true
}

RateCardSubscription event types v2

This is a list of all public thin events we currently send for updates to RateCardSubscription, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

v2.billing.rate_card_subscription.activated

Occurs when a RateCardSubscription is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkWu5OkQpDEMaiRW16RuKJoESSQUtPVJKIgeI4D2O4u",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkWu5OkQpDEMaiRW16RuKJoESSQUtPVJKIgeI4D2O4u",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkWtdXF98pUnZ216RuKJoESSQUtPVJKIgeI4D2IcC"
  },
  "data": {}
}

v2.billing.rate_card_subscription.canceled

Occurs when a RateCardSubscription is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJdUVzgT7qF1coE7Z16RuKJoESSQUtPVJKIgeI4D26vS",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJdUVzgT7qF1coE7Z16RuKJoESSQUtPVJKIgeI4D26vS",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJdTQAyZPxN9yjs16RuKJoESSQUtPVJKIgeI4D21IY"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_awaiting_customer_action

Occurs when a RateCardSubscription's collection is awaiting customer action.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_awaiting_customer_action"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJcTUyfS6pE0bnD6Z16RuKJoESSQUtPVJKIgeI4D25uR",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJcTUyfS6pE0bnD6Z16RuKJoESSQUtPVJKIgeI4D25uR",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJcSPzxYOwM8xis16RuKJoESSQUtPVJKIgeI4D20HX"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_current

Occurs when a RateCardSubscription's collection is current.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_current"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJbSTxeR5oD9amC5Z16RuKJoESSQUtPVJKIgeI4D24tQ",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJbSTxeR5oD9amC5Z16RuKJoESSQUtPVJKIgeI4D24tQ",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJbROywXNvL7whs16RuKJoESSQUtPVJKIgeI4D29GW"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_past_due

Occurs when a RateCardSubscription's collection is past due.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_past_due"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLbcODkA5Zd7rZ16RuKJoESSQUtPVJKIgeI4D2BpA",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_paused

Occurs when a RateCardSubscription's collection is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJaRSwdQ4nC8ZlB4Z16RuKJoESSQUtPVJKIgeI4D23sP",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJaRSwdQ4nC8ZlB4Z16RuKJoESSQUtPVJKIgeI4D23sP",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJaQNxvWMuK6vgs16RuKJoESSQUtPVJKIgeI4D28FV"
  },
  "data": {}
}

v2.billing.rate_card_subscription.collection_unpaid

Occurs when a RateCardSubscription's collection is unpaid.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.collection_unpaid"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJZQRvdP3mB7YkA3Z16RuKJoESSQUtPVJKIgeI4D22rO",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJZQRvdP3mB7YkA3Z16RuKJoESSQUtPVJKIgeI4D22rO",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJZPMwuVLtJ5ufs16RuKJoESSQUtPVJKIgeI4D27EU"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_activated

Occurs when RateCardSubscription servicing is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkTii5W2uQbFXIqZ16RuKJoESSQUtPVJKIgeI4D28xE",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SKkTii5W2uQbFXIqZ16RuKJoESSQUtPVJKIgeI4D28xE",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SKkThVvJOfROyY416RuKJoESSQUtPVJKIgeI4D2UCm"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_canceled

Occurs when RateCardSubscription servicing is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYGHqRm3bvDPUwrJ16RuKJoESSQUtPVJKIgeI4D21qN",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYGHqRm3bvDPUwrJ16RuKJoESSQUtPVJKIgeI4D21qN",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYEFxtTKrH4tds16RuKJoESSQUtPVJKIgeI4D26DT"
  },
  "data": {}
}

v2.billing.rate_card_subscription.servicing_paused

Occurs when RateCardSubscription servicing is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.rate_card_subscription.servicing_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLfEo2XvVPUgrZ16RuKJoESSQUtPVJKIgeI4D20pM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJYFLfEo2XvVPUgrZ16RuKJoESSQUtPVJKIgeI4D20pM",
  "object": "v2.core.event",
  "type": "v2.billing.rate_card_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS",
    "type": "v2.billing.rate_card_subscription",
    "url": "/v2/billing/rate_card_subscriptions/rcds_61SJYD6xtUKrI0tfs16RuKJoESSQUtPVJKIgeI4D25CS"
  },
  "data": {}
}

Pricing Plans v2

A PricingPlan describes a collection of pricing components that can be used to bill customers. To bill a customer using a PricingPlan, create a PricingPlanSubscription which links it to the corresponding Cadence.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/billing/pricing_plans

POST/v2/billing/pricing_plans/:id/components

POST/v2/billing/pricing_plans/:id

POST/v2/billing/pricing_plans/:id/components/:id

GET/v2/billing/pricing_plans/:id

GET/v2/billing/pricing_plans/:id/components/:id

GET/v2/billing/pricing_plans/:id/versions/:id

GET/v2/billing/pricing_plans/:id/components

GET/v2/billing/pricing_plans

GET/v2/billing/pricing_plans/:id/versions

DELETE/v2/billing/pricing_plans/:id/components/:id

Retrieve a rate card subscription v2

Parameters

idstringRequired

Returns

Response attributes

idstring

objectstring, value is "v2.billing.rate_card_subscription"

billing_cadencestring

collection_statusnullable enum

collection_status_transitionsnullable object

createdtimestamp

livemodeboolean

metadatanullable map

rate_cardstring

rate_card_versionstring

servicing_statusnullable enum

servicing_status_transitionsnullable object

test_clocknullable string

List rate card subscriptions v2

Parameters

billing_cadencestring

limitinteger

pagestring

payerobject

rate_cardstring

rate_card_versionstring

servicing_statusenum

Returns

Response attributes

dataarray of objects

next_page_urlnullable string

previous_page_urlnullable string

Cancel a rate card subscription v2

Parameters

idstringRequired

Returns

Response attributes

idstring

objectstring, value is "v2.billing.rate_card_subscription"

billing_cadencestring

collection_statusnullable enum

collection_status_transitionsnullable object

createdtimestamp

livemodeboolean

metadatanullable map

rate_cardstring

rate_card_versionstring

servicing_statusnullable enum

servicing_status_transitionsnullable object

test_clocknullable string

RateCardSubscription event types v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.rate_card_subscription.activated"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.billing.rate_card_subscription.canceled"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean