Deprecated API Reference

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

Update Subscription Amount

Update a previously created Subscription Amount. This creates a new Subscription Amount resource.

attention

The updated Subscription Amount ID cannot be updated more than once.

Copy

Copied

curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_7qgPxRxYdRvN4LRXboYoeN \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e \
    -X PATCH \
    -d '
	{
	    "amount": 5000,
	    "amount_type": "FEE"
	}'

Example Response:

Copy

Copied

{
  "id" : "SUBAMOUNT_kcH6Rnw225kgryhPWusMYj",
  "created_at" : "2022-10-10T03:14:09.69Z",
  "updated_at" : "2022-10-10T03:14:09.69Z",
  "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" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts/SUBAMOUNT_kcH6Rnw225kgryhPWusMYj"
    },
    "schedule" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ"
    }
  }
}

HTTP Request

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

URL Parameters

`Parameter`	Description
:SUBSCRIPTION_SCHEDULE_ID	ID of the `Subscription Schedule`
:SUBSCRIPTION_AMOUNT_ID	ID of the `Subscription Amount`

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, optional	`Subscription Amount` name

Fee Amount Object Request Arguments

Field	Type	Description
`amount`	integer, optional	A positive integer in cents representing how much to charge on a recurring basis
`currency`	string, optional	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`
`created_by`	string	`User` ID
`fee_amount_data`	object	Key value pair specifying amount and currency
`amount`	integer	A positive integer in cents representing how much to charge on a recurring basis
`currency`	string	Three-letter ISO currency code in uppercase
`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)