GET /subscription/subscription_schedules/{id}/subscription_amounts
POST /subscription/subscription_schedules
GET /subscription/subscription_schedules/{id}
PUT /subscription/subscription_schedules/{id}
DEL /subscription/subscription_schedules/{id}
The Subscription Amount
is the amount that gets charged to a Merchant
. The Subscription Amount
must be associated with a Subscription Schedule
.
Related Guides: Subscription Billing
Retrive a list of Subscription Amounts
.
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. |
tags.key | string Filter by the |
tags.value | string Filter by the value of a |
List of subscription_amount objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
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
{- "_embedded": {
- "subscription_amounts": [
- {
- "id": "SUBAMOUNT_cTJQifghT2FLRR7ttJapXH",
- "created_at": "2022-08-01T18:04:24.52Z",
- "updated_at": "2022-08-01T18:04:24.52Z",
- "amount_type": "FEE",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fee_amount_data": {
- "amount": 2500,
- "currency": "USD",
- "label": "POS_INSTALLMENT_FEE"
}, - "nickname": "NEW_POS_INSTALLMENT_FEE",
- "subscription_schedule": "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
- "tags": { },
- "_links": {
}
}, - {
- "id": "SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN",
- "created_at": "2022-06-24T17:15:10.68Z",
- "updated_at": "2022-06-24T17:15:10.68Z",
- "amount_type": "FEE",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fee_amount_data": {
- "amount": 2500,
- "currency": "USD",
- "label": "POS_INSTALLMENT_FEE"
}, - "nickname": "POS_INSTALLMENT_FEE",
- "subscription_schedule": "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
- "tags": { },
- "_links": {
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 2
}
}
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
.
Single subscription_amount object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
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" } }'
{- "id": "SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN",
- "created_at": "2022-06-24T17:15:10.68Z",
- "updated_at": "2022-06-24T17:15:10.68Z",
- "amount_type": "FEE",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fee_amount_data": {
- "amount": 2500,
- "currency": "USD",
- "label": "POS_INSTALLMENT_FEE"
}, - "nickname": "POS_INSTALLMENT_FEE",
- "subscription_schedule": "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
- "tags": { },
- "_links": {
}
}
Retrieve the details of a subscription_amount
.
Single subscription_amount object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
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
{- "id": "SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN",
- "created_at": "2022-06-24T17:15:10.68Z",
- "updated_at": "2022-06-24T17:15:10.68Z",
- "amount_type": "FEE",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fee_amount_data": {
- "amount": 2500,
- "currency": "USD",
- "label": "POS_INSTALLMENT_FEE"
}, - "nickname": "POS_INSTALLMENT_FEE",
- "subscription_schedule": "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
- "tags": { },
- "_links": {
}
}
Update the details of a subscription_amount
.
Single subscription_amount object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
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" } }'
{- "id": "SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN",
- "created_at": "2022-06-24T17:15:10.68Z",
- "updated_at": "2022-06-24T17:15:10.68Z",
- "amount_type": "FEE",
- "created_by": "UStxEci4vXxGDWLQhNvao7YY",
- "fee_amount_data": {
- "amount": 2500,
- "currency": "USD",
- "label": "POS_INSTALLMENT_FEE"
}, - "nickname": "POS_INSTALLMENT_FEE",
- "subscription_schedule": "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
- "tags": { },
- "_links": {
}
}
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.
No Content
Object does not exist
Forbidden
Authentication information is missing or invalid
Not Acceptable
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
{- "total": 0,
- "_embedded": {
- "errors": [
- {
- "code": "NOT_FOUND",
- "logref": {
- "logref": "string"
}, - "message": "string",
- "_links": {
- "source": {
- "href": "string"
}
}
}
]
}
}