List Subscription Amounts

Retrive a list of Subscription Amounts.

Request
path Parameters
subscription_schedule_id
required
string

The ID of the Subscription Schedule.

query Parameters
limit
integer

The numbers of items to return.

Example: limit=10
after_cursor
string

Return every resource created after the cursor value.

before_cursor
string

Return every resource created before the cursor value.

Responses
200

List of subscription_amount objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/ \
  -H "Content-Type: application/vnd.api+json" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/hal+json
{}

Create a Subscription Amount

Create a subscription_amount.

The Subscription Amount is the amount to be charged to a Merchant. The Subscription Amount must be associated to a Subscription Schedule.

Request
path Parameters
subscription_schedule_id
required
string

The ID of the Subscription Schedule.

Request Body schema: application/hal+json
amount_type
required
string non-empty

Subscription Amount type. For subscriptions, the type is FEE.

required
object

The amount and currency of this Subsciption Amount.

nickname
string

Human readable name.

tags
object or null

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.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
200

Single subscription_amount object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X POST \
  -d '
  {
    "amount_type": "FEE",
    "fee_amount_data": {
      "amount": 2500,
      "currency": "USD",
      "label": "POS_INSTALLMENT_FEE"
    },
    "nickname": "POS_INSTALLMENT_FEE",
    "tags": {
      "order_number": "124"
    }
  }'
Response samples
application/hal+json
{}

Fetch a Subscription Amount

Retrieve the details of a subscription_amount.

Request
path Parameters
subscription_amount_id
required
string

The ID of the Subscription Amount.

subscription_schedule_id
required
string

The ID of the Subscription Schedule.

Responses
200

Single subscription_amount object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts/{subscription_amount_id}
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN \
  -H "Content-Type: application/vnd.api+json" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/hal+json
{}

Update a Subscription Amount

Update the details of a subscription_amount.

Request
path Parameters
subscription_amount_id
required
string

The ID of the Subscription Amount.

subscription_schedule_id
required
string

The ID of the Subscription Schedule.

Request Body schema: application/hal+json
amount_type
required
string non-empty

Subscription Amount type. For subscriptions, the type is FEE.

required
object

The amount and currency of this Subsciption Amount.

nickname
string

Human readable name.

tags
object or null

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.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
200

Single subscription_amount object

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

put/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts/{subscription_amount_id}
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN \
  -H "Content-Type: application/vnd.api+json" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X PUT \
  -d '
  {
    "amount_type": "FEE",
    "fee_amount_data": {
      "amount": 2500,
      "currency": "USD",
      "label": "POS_INSTALLMENT_FEE"
    },
    "nickname": "POS_INSTALLMENT_FEE",
    "tags": {
      "order_number": "124"
    }
  }'
Response samples
application/hal+json
{}

Delete a Subscription Amount

Delete a previously created Subscription Amount.

Per the JSON API for deleting a resource, our API doesn't have a response body when removing a Subsciption Amount.

Request
path Parameters
subscription_amount_id
required
string

The ID of the Subscription Amount.

subscription_schedule_id
required
string

The ID of the Subscription Schedule.

Responses
204

No Content

401

Object does not exist

403

Forbidden

404

Authentication information is missing or invalid

406

Not Acceptable

delete/subscription/subscription_schedules/{subscription_schedule_id}/subscription_amounts/{subscription_amount_id}
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X DELETE
Response samples
application/hal+json
{
  • "total": 0,
  • "_embedded": {
    • "errors": [
      ]
    }
}