Deprecated API Reference

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

Create Subscription Schedule FIXED_TIME_INTERVAL

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 FIXED_TIME_INTERVAL Subscription Schedule charges a Merchant on a fixed hourly interval.

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 '
	{
	    "fixed_time_interval_offset": {
	        "hourly_interval": 24,
	        "interval_count": 4
	    },
	    "line_item_type": "FEE",
	    "nickname": "Fixed_Time_Subscription_Schedule",
	    "subscription_type": "FIXED_TIME_INTERVAL"
	}'

Example Response:

Copy
Copied
{
  "id" : "SUBSCHEDULE_sV46pEKGLcLVLMMz3hnZAg",
  "created_at" : "2022-10-10T02:40:07.00Z",
  "updated_at" : "2022-10-10T02:40:07.00Z",
  "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
  "fixed_time_interval_offset" : {
    "hourly_interval" : 24,
    "interval_count" : 4
  },
  "line_item_type" : "FEE",
  "nickname" : "Fixed_Time_Subscription_Schedule",
  "period_offset" : null,
  "subscription_type" : "FIXED_TIME_INTERVAL",
  "tags" : { },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_sV46pEKGLcLVLMMz3hnZAg"
    },
    "amounts" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_sV46pEKGLcLVLMMz3hnZAg/subscription_amounts"
    }
  }
}

HTTP Request

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

Fixed-time Interval Offset Request Arguments

Field Type Description
hourly_interval integer, required Hourly increments between recurring charges
interval_count integer, required Number of recurring charges

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 type is: FIXED_TIME_INTERVAL
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
hourly_interval integer Hourly increments between recurring charges
interval_count integer Number of recurring charges
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. This field is null for FIXED_TIME_INTERVAL Subscription Schedules
subscription_type string Subscription Schedule type
tags object Key value pair for annotating custom metadata (e.g. order numbers)