Deprecated API Reference

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

List Subscription Schedules

List all previously created Subscription Schedules. Responses may vary depending on the type of Subscription Schedule.

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

Example Response:

Copy
Copied
{
  "_embedded" : {
    "subscription_schedules" : [ {
      "id" : "SUBSCHEDULE_kmmGpfGdAuPELr7ifgmRcB",
      "created_at" : "2022-10-10T02:45:33.74Z",
      "updated_at" : "2022-10-10T02:45:33.74Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "fixed_time_interval_offset" : null,
      "line_item_type" : "FEE",
      "nickname" : "Monthly_Subscription_Schedule",
      "period_offset" : {
        "day" : 1,
        "month" : null
      },
      "subscription_type" : "PERIODIC_MONTHLY",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kmmGpfGdAuPELr7ifgmRcB"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kmmGpfGdAuPELr7ifgmRcB/subscription_amounts"
        }
      }
    }, {
      "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"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_m99psZnEzBGzSSoYJss3Td",
      "created_at" : "2022-07-18T20:10:15.25Z",
      "updated_at" : "2022-07-18T20:10:15.25Z",
      "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_m99psZnEzBGzSSoYJss3Td"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m99psZnEzBGzSSoYJss3Td/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_m87Aaurcd8BRyeKMJdcoB2",
      "created_at" : "2022-07-18T20:10:15.01Z",
      "updated_at" : "2022-07-18T20:10:15.01Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "fixed_time_interval_offset" : null,
      "line_item_type" : "FEE",
      "nickname" : "Monthly_Subscription_Schedule",
      "period_offset" : {
        "day" : 1,
        "month" : null
      },
      "subscription_type" : "PERIODIC_MONTHLY",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m87Aaurcd8BRyeKMJdcoB2"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m87Aaurcd8BRyeKMJdcoB2/subscription_amounts"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "last" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules?offset=60&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 76
  }
}

HTTP Request

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

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
day integer Specifies the day when the Subscription Schedule starts
month integer Specifies the month when the Subscription Schedule starts. This field is null for PERIODIC_MONTHLY subscriptions
subscription_type string Subscription Schedule type
tags object Key value pair for annotating custom metadata (e.g. order numbers)