Create Subscription Usage-based Billing Product

Associate an existing usage-based billing product with a subscription

This endpoint allows you to create a subscription usage-based billing product, which associates an existing usage-based billing product with a specific subscription. This association enables usage-based billing for the subscription.

Key Concepts

  1. Unbilled Usage Strategy: Defines how to handle existing unbilled usage records when re-adding the same usage-based billing product to a subscription.
  2. Pricing Strategy: Determines whether the subscription will use flexible or fixed pricing for the usage-based billing product.

Unbilled Usage Strategies

When creating a subscription usage-based billing product, you must specify one of the following unbilled usage strategies:

  • WRITE_OFF: All reported metered records will be deleted and will not be billed at the end of the billing cycle.
  • NEXT_BILLING_CYCLE: All reported usage records will be billed in the next billing cycle.

Pricing Strategies

You must also specify one of the following pricing strategies:

  • FLEXIBLE: The subscription usage-based billing product will adopt any future updates to the associated usage-based billing product's pricing.
  • FIXED: The subscription usage-based billing product will maintain a fixed price, regardless of any updates to the associated usage-based billing product.

Important Notes

  • To update a subscription usage-based billing product, you must first remove it from the subscription and then re-add it with the new settings.
  • Carefully consider the implications of your chosen unbilled usage and pricing strategies, as they will affect how the subscription is billed and how it responds to changes in the underlying usage-based billing product.

Related Endpoints

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!