Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Create Subscription Amount

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

Copy
Copied
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e \
    -d '
	{
	    "amount_type": "FEE",
	    "fee_amount_data": {
	        "amount": 2500,
	        "currency": "USD",
	        "label": "POS_INSTALLMENT_FEE"
	    },
	    "nickname": "POS_INSTALLMENT_FEE",
	    "tags": {
	        "order_number": "124"
	    }
	}'

Example Response:

Copy
Copied
{
  "id" : "SUBAMOUNT_uKg6g5SL5mbAUcbt7PkDDq",
  "created_at" : "2022-01-27T07:44:08.16Z",
  "updated_at" : "2022-01-27T07:44:08.16Z",
  "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" : {
    "order_number" : "124"
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_uKg6g5SL5mbAUcbt7PkDDq"
    },
    "schedule" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ"
    }
  }
}

HTTP Request

POST https://finix.sandbox-payments-api.com/subscription/subscription_schedules/:SUBSCRIPTION_SCHEDULE_ID/subscription_amounts

URL Parameters

Parameter Description
:SUBSCRIPTION_SCHEDULE_ID ID of the Subscription Schedule

Request Arguments

Field Type Description
amount_type string, required Subscription Amount type. For subscriptions, the type is FEE
fee_amount_data object, required Key value pair specifying amount and currency
nickname string, required Subscription Amount name
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers)

Fee Amount Object Request Arguments

Field Type Description
amount integer, required A positive integer in cents representing how much to charge on a recurring basis
currency string, required Three-letter ISO currency code in uppercase
label string, optional The display name of the Settlement that can be used for filtering purposes

Response

Field Type Description
id string ID of the Subscription Amount
created_at string Timestamp of when the Subscription Amount was created
updated_at string Timestamp of when the Subscription Amount was last updated
amount_type string Subscription Amount type. For subscriptions, the type is FEE
amount integer A positive integer in cents representing how much to charge on a recurring basis
created_by string User ID
currency string Three-letter ISO currency code in uppercase
fee_amount_data object Key value pair specifying amount and currency
label string The display name of the Settlement that can be used for filtering purposes
nickname string Subscription Amount name
subscription_schedule string ID of the Subscription Schedule
tags object Key value pair for annotating custom metadata (e.g. order numbers)