Deprecated API Reference

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

Create Subscription Schedule PERIODIC_YEARLY

The Subscription Schedule details when the Fee is charged to the Merchant . There are three types of Subscription Schedules available: FIXED_TIME_INTERVAL, PERIODIC_MONTHLY, or PERIODIC_YEARLY. The PERIODIC_YEARLY Subscription Schedule charges a Merchant once a year on a specific day and month.

Copy
Copied
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e \
    -d '
	{
	    "line_item_type": "FEE",
	    "nickname": "Yearly_Subscription_Schedule",
	    "period_offset": {
	        "day": 5,
	        "month": 1
	    },
	    "subscription_type": "PERIODIC_YEARLY"
	}'

Example Response:

Copy
Copied
{
  "id" : "SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru",
  "created_at" : "2022-01-27T07:44:05.81Z",
  "updated_at" : "2022-01-27T07:44:05.81Z",
  "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
  "fixed_time_interval_offset" : null,
  "line_item_type" : "FEE",
  "nickname" : "Yearly_Subscription_Schedule",
  "period_offset" : {
    "day" : 5,
    "month" : 1
  },
  "subscription_type" : "PERIODIC_YEARLY",
  "tags" : { },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru"
    },
    "amounts" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru/subscription_amounts"
    }
  }
}

HTTP Request

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

Period Offset Request Arguments

Field Type Description
day integer, required Specifies the day when the Subscription Schedule starts
month integer, optional Specifies the month when the Subscription Schedule starts. If the Subscription Schedule is PERIODIC_MONTHLY, the month field can be left null

Request Arguments

Field Type Description
line_item_type string, required Subscription Schedule type. For subscriptions, the type is FEE
nickname string, required Subscription Schedule name
subscription_type string, required Subscription Schedule type. Available types are: PERIODIC_MONTHLY or PERIODIC_YEARLY
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers)

Response

Field Type Description
id string ID of the Subscription Schedule
created_at string Timestamp of when the Subscription Schedule was created
updated_at string Timestamp of when the Subscription Schedule was last updated
created_by string User ID
fixed_time_offset object Specifies when the Fee is charged. This field is null for PERIODIC Subscription Schedules
line_item_type string Subscription Schedule type. For subscriptions, the type is FEE
nickname string Subscription Schedule name
period_offset object Specifies when the Fee is charged
day integer Specifies the day when the Subscription Schedule starts
month integer Specifies the month when the Subscription Schedule starts. This field will be null for PERIODIC_MONTHLY subscriptions
subscription_type string Subscription Schedule type
tags object Key value pair for annotating custom metadata (e.g. order numbers)