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

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of subscription_amount objects.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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.json+api" \
  -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.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
200

Single subscription_amount object

Response Schema: application/hal+json
id
string non-empty

ID of the Subscription Amount.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount_type
string

Subscription Amount type. The only type supported as of now is FEE.

Value: "FEE"
created_by
string non-empty

The ID of the User that created the Subscription Amount.

object

The amount and currency of this Subsciption Amount.

nickname
string

Human readable name.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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
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

Response Schema: application/hal+json
id
string non-empty

ID of the Subscription Amount.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount_type
string

Subscription Amount type. The only type supported as of now is FEE.

Value: "FEE"
created_by
string non-empty

The ID of the User that created the Subscription Amount.

object

The amount and currency of this Subsciption Amount.

nickname
string

Human readable name.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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.json+api" \
  -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.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
200

Single subscription_amount object

Response Schema: application/hal+json
id
string non-empty

ID of the Subscription Amount.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

amount_type
string

Subscription Amount type. The only type supported as of now is FEE.

Value: "FEE"
created_by
string non-empty

The ID of the User that created the Subscription Amount.

object

The amount and currency of this Subsciption Amount.

nickname
string

Human readable name.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

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
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
Response samples
application/hal+json
{
  • "total": 0,
  • "_embedded": {
    • "errors": [
      ]
    }
}