Reserve a Billing Intent.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the Billing Intent to reserve.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.billing.intent"
String representing the object’s type. Objects of the same type share the same value of the object field.
- amount_
detailsobject Breakdown of the amount for this Billing Intent.
- cadencenullable string
ID of an existing Cadence to use.
- createdtimestamp
Time at which the object was created.
- currencystring
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - statusenum
Current status of the Billing Intent.
Possible enum valuescanceledThe Billing Intent is canceled.
committedThe Billing Intent is committed.
draftThe Billing Intent is in draft state.
reservedThe Billing Intent is reserved.
- status_
transitionsobject Timestamps for status transitions of the Billing Intent.
Returned when the billing intent total amount due is greater than the maximum amount allowed.
Returned when the billing intent total amount due is less than the minimum amount allowed.
Returned when trying to reserve a billing intent and the status is not in draft.
Returned when billing intent is not found.
{ "amount_details": { "currency": "usd", "discount": 0, "shipping": 0, "subtotal": 2000, "tax": 200, "total": 2200 }, "created": "2025-01-01T00:00:00.000Z", "currency": "usd", "id": "bilint_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy", "object": "v2.billing.billing_intent", "status": "reserved", "status_transitions": { "canceled_at": null, "committed_at": null, "drafted_at": "2025-01-01T00:00:00.000Z", "reserved_at": "2025-01-01T00:00:00.000Z" }, "livemode": true, "cadence": "bc_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"}A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
Related guide: Usage based billing
Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.
Meter Events v2
Meter events are used to report customer usage of your product or service. Meter events are associated with billing meters, which define the shape of the event’s payload and how those events are aggregated. Meter events are processed asynchronously, so they may not be immediately reflected in aggregates or on upcoming invoices.