Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Subscriptions

Create a Subscription Balance Entry

Create a Subscription Balance Entry. A Subscription Balance Entry represents a credit applied to a Subscription.

post/subscriptions/{subscription_id}/subscription_balance_entries

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

currency'USD'

ISO 4217 3-letter currency code. Currently, the only currency supported is USD.

descriptionstring

A description of the reason for the subscription credit. Does not support special characters.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'CREDIT' required

Will always be CREDIT.

Example request

{
  "amount": 5000
}

Response

A single Subscription Balance Entry

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

currency'USD'

ISO 4217 3-letter currency code. Currently, the only currency supported is USD.

descriptionstring

Describes the circumstances for the subscription credit.

subscription_idstring

The Subscription that was credited.

typestring

The value of this field will always be CREDIT.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "amount": 5000
}