Fetch a Subscription Schedule

Retrieve the details of a subscription_schedule

Request
path Parameters
subscription_schedule_id
required
string

The ID of the Subscription Schedule.

query Parameters
nickname
string

Filter by the object's nickname.

type
string

Filter by the object's subscription_type.

header Parameters
Accept
string
Default: application/hal+json
Responses
200

Example response

401

Authentication information is missing or invalid

403

Forbidden

404

Not Found

406

Not Acceptable

get/subscription/subscription_schedules/{subscription_schedule_id}
Request samples
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV" \
  -H "Finix-Version: 2022-02-01" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/json
{}

Update a Subscription Schedule

Update the details of a subscription_schedule.

Request
path Parameters
subscription_schedule_id
required
string

The ID of the Subscription Schedule.

header Parameters
Accept
string
Default: application/hal+json
Request Body schema: application/json
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

Example response

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

put/subscription/subscription_schedules/{subscription_schedule_id}
Request samples
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uKKHic71ZD9FicJ89mhcNV" \
  -H "Content-Type: application/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X PUT \
  -d '
  {
    "tags": {
      "order-reference": "A1B2C3D4E5"
    }
  }'
Response samples
application/json
{}

List Subscription Schedules

Retrieve a list of subscription_schedules.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
query Parameters
nickname
string

Filter by the object's nickname.

type
string

Filter by the object's type.

header Parameters
Accept
string
Default: application/hal+json
Responses
200

List of subscription_schedule objects

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_schedules
Request samples
curl "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/" \
  -H "Finix-Version: 2022-02-01" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/json
{}

Create a Subscription Schedule

Create a subscription_schedule.

Request
header Parameters
Accept
string
Default: application/hal+json
Finix-Version
string
Default: 2018-01-01

Specify the API version of your request. For more details, see Versioning.

Example: 2022-02-01
Request Body schema: application/json
object or null

Specifies when the Fee is charged

line_item_type
required
string non-empty

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

Value: "FEE"
nickname
required
string

Human readable name.

object or null

Specifies when the Fee is charged. This field is null for FIXED_TIME_INTERVAL subscription schedules

subscription_type
required
string

Specify the type of schedule:

  • FIXED_TIME_INTERVAL: Charges a Merchant on a fixed hourly interval.
  • PERIODIC_MONTHLY: Charges a Merchant once a month on a specific day.
  • PERIODIC_YEARLY: Charges a Merchant once a year on a specific day and month.
Enum: "FIXED_TIME_INTERVAL" "PERIODIC_MONTHLY" "PERIODIC_YEARLY"
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

Example response

401

Unauthorized

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/subscription/subscription_schedules
Request samples
Response samples
application/json
{}