A RateCardSubscription links a RateCard to a specific billing Cadence. While the RateCardSubscription is active, Stripe will bill the Payer according to the RateCard’s pricing.
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 valuesawaiting_customer_ action The subscription payment is pending and requires customer action.
currentThe 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.
pausedPayment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.
unpaidAll 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
trueif the object exists in live mode or the valuefalseif 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 valuesactiveThe provisionee of this subscription is receiving servicing.
canceledServicing for this subscription is canceled.
pausedThe servicing for the provisionee of this subscription is paused.
pendingThe 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.
{ "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"}Create a RateCardSubscription to bill a RateCard on a specified billing Cadence.
Learn more about calling API v2 endpoints.Parameters
- billing_
cadencestringRequired The ID of the billing Cadence.
- rate_
cardstringRequired The ID of the RateCard.
- metadatamap
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_
card_ versionstring The ID of the RateCardVersion. If not specified, defaults to the “live_version” of the RateCard at the time of creation.
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 valuesawaiting_customer_ action The subscription payment is pending and requires customer action.
currentThe 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.
pausedPayment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.
unpaidAll 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
trueif the object exists in live mode or the valuefalseif 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 valuesactiveThe provisionee of this subscription is receiving servicing.
canceledServicing for this subscription is canceled.
pausedThe servicing for the provisionee of this subscription is paused.
pendingThe 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.
Returned when trying to cancel a billing cadence that has already been canceled.
Returned when creating a rate card subscription for a billing cadence and the rate card currency does not match the billing cadence currency.
Returned when the ManualTaxConfiguration is inactive.
Returned when a user tries to modify a rate or subscription for an inactive rate card.
Returned when a user tries to create a rate card subscription for a billing cadence that has already subscribed to the same rate card.
Returned when the rate card servicing interval exceeds the billing cadence cycle length.
Returned when a user tries to create a rate card subscription for a billing cadence that has already reached the limit of active subscriptions.
Returned when no rates can be found for the given rate card ID and version.
Returned when the customer for the provided ID cannot be found.
Returned when no ManualTaxConfiguration object was found for the given ID.
Returned when the merchant ID cannot be determined for this workspace.
Returned when the provided rate_card ID cannot be found.
Returned when the provided rate_card_version ID cannot be found.
{ "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}Update fields on an existing, active RateCardSubscription.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the RateCardSubscription to update.
- metadatamap
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.
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 valuesawaiting_customer_ action The subscription payment is pending and requires customer action.
currentThe 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.
pausedPayment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.
unpaidAll 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
trueif the object exists in live mode or the valuefalseif 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 valuesactiveThe provisionee of this subscription is receiving servicing.
canceledServicing for this subscription is canceled.
pausedThe servicing for the provisionee of this subscription is paused.
pendingThe 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.
Returned when the Update RateCardSubscription RPC is called with a status=canceled RateCardSubscription.
Returned when a RateCardSubscription by the provided ID cannot be found.
{ "id": "rcds_test_61Rc0Iuz3V1KJFCSG16RM8VQESSQ4t1K5KYFAmKUS7XM", "object": "v2.billing.rate_card_subscription", "billing_cadence": "bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie", "metadata": { "my_key": "my_value" }, "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}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 valuesawaiting_customer_ action The subscription payment is pending and requires customer action.
currentThe 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.
pausedPayment collection for the subscription is temporarily paused. The subscription may be resumed in the future, but no payments are being processed at this time.
unpaidAll 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
trueif the object exists in live mode or the valuefalseif 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 valuesactiveThe provisionee of this subscription is receiving servicing.
canceledServicing for this subscription is canceled.
pausedThe servicing for the provisionee of this subscription is paused.
pendingThe 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.
Returned when a RateCardSubscription by the provided ID cannot be found.
{ "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}