Deprecated API Reference

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

Fetch Subscription Schedule of type PERIODIC

Fetch a previously created Subscription Schedule of type PERIODIC.

Copy
Copied
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uzbKGz4eHynQrn5ekkEAru \
    -H "Content-Type: application/vnd.json+api" \
    -H 'Finix-Version:2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e

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

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

URL Parameters

Parameter Description
:SUBSCRIPTION_SCHEDULE_ID ID of the PERIODIC Subscription Schedule

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
subscription_type string Subscription Schedule type
tags object Key value pair for annotating custom metadata (e.g. order numbers)