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.

Responses
200

Example response

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

ID of the Subscription Schedule.

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.

created_by
string non-empty

User ID who created the schedule.

object or null

Specifies when the Fee is charged.

line_item_type
string non-empty

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

Value: "FEE"
nickname
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
string non-empty

Subscription Schedule type.

Enum: "PERIODIC_MONTHLY" "PERIODIC_YEARLY" "FIXED_TIME_INTERVAL"
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

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 "Content-Type: application/vnd.json+api" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/hal+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.

Request Body schema: application/hal+json
object

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

Responses
200

Example response

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

ID of the Subscription Schedule.

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.

created_by
string non-empty

User ID who created the schedule.

object or null

Specifies when the Fee is charged.

line_item_type
string non-empty

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

Value: "FEE"
nickname
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
string non-empty

Subscription Schedule type.

Enum: "PERIODIC_MONTHLY" "PERIODIC_YEARLY" "FIXED_TIME_INTERVAL"
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}
Request samples
Response samples
application/hal+json
{}

List Subscription Schedules

Retrieve a list of Subscription Schedules.

Request
query Parameters
nickname
string

Filter by the object's nickname.

type
string

Filter by the object's type.

Responses
200

List of subscription_schedule objects

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of subscription_schedule 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
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/ \
  -H "Content-Type: application/vnd.json+api" \
  -u UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e
Response samples
application/hal+json
{}

Create a Subscription Schedule

Create a subscription_schedule.

Request
Request Body schema: application/hal+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

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

Responses
200

Example response

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

ID of the Subscription Schedule.

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.

created_by
string non-empty

User ID who created the schedule.

object or null

Specifies when the Fee is charged.

line_item_type
string non-empty

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

Value: "FEE"
nickname
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
string non-empty

Subscription Schedule type.

Enum: "PERIODIC_MONTHLY" "PERIODIC_YEARLY" "FIXED_TIME_INTERVAL"
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

Unauthorized

403

Forbidden

404

Object does not exist

406

Not Acceptable

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