Deprecated API Reference

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

Fetch Subscription Schedule with Filters

Fetch a Subscription Schedule using filters. Filters include: nickname and Subscription Schedule type.

Copy

Copied

curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/?nickname=Monthly_Subscription_Schedule \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e

Example Response:

Copy

Copied

{
  "_embedded" : {
    "subscription_schedules" : [ {
      "id" : "SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8",
      "created_at" : "2022-01-27T07:44:06.18Z",
      "updated_at" : "2022-01-27T07:44:06.18Z",
      "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_uANjZPtZGzh4MK6aFFzbC8"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uANjZPtZGzh4MK6aFFzbC8/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_kY8fuHfsoXWopwskSYKjzE",
      "created_at" : "2022-01-26T23:35:23.12Z",
      "updated_at" : "2022-01-26T23:35:23.12Z",
      "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_kY8fuHfsoXWopwskSYKjzE"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kY8fuHfsoXWopwskSYKjzE/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_bpdSWMpjwqv8w6HqDKNWfo",
      "created_at" : "2022-01-13T00:04:08.33Z",
      "updated_at" : "2022-01-13T00:04:08.33Z",
      "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_bpdSWMpjwqv8w6HqDKNWfo"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bpdSWMpjwqv8w6HqDKNWfo/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_qik2T8iPqHfqDpW67mniow",
      "created_at" : "2022-01-12T22:41:23.20Z",
      "updated_at" : "2022-01-12T22:41:23.20Z",
      "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_qik2T8iPqHfqDpW67mniow"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qik2T8iPqHfqDpW67mniow/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_f5TJFaSEbknvduAEg9gaE2",
      "created_at" : "2022-01-08T00:53:51.15Z",
      "updated_at" : "2022-01-08T00:53:51.15Z",
      "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_f5TJFaSEbknvduAEg9gaE2"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f5TJFaSEbknvduAEg9gaE2/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_7BVRFS8nAyBJ2h9qa5DSds",
      "created_at" : "2022-01-07T18:39:55.90Z",
      "updated_at" : "2022-01-07T18:39:55.90Z",
      "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_7BVRFS8nAyBJ2h9qa5DSds"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7BVRFS8nAyBJ2h9qa5DSds/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_5EwwTEScKDyMPo54mLzZwC",
      "created_at" : "2022-01-06T02:19:59.44Z",
      "updated_at" : "2022-01-06T02:19:59.44Z",
      "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_5EwwTEScKDyMPo54mLzZwC"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5EwwTEScKDyMPo54mLzZwC/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_dkcKp2LRsZ8RjkZ9i9KHJn",
      "created_at" : "2022-01-05T02:08:35.77Z",
      "updated_at" : "2022-01-05T02:08:35.77Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "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_dkcKp2LRsZ8RjkZ9i9KHJn"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_dkcKp2LRsZ8RjkZ9i9KHJn/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_aG6cZ5ns93WeXTdtAWULbe",
      "created_at" : "2022-01-04T21:57:27.52Z",
      "updated_at" : "2022-01-04T21:57:27.52Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "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_aG6cZ5ns93WeXTdtAWULbe"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_aG6cZ5ns93WeXTdtAWULbe/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_iVJKb2A4TMedsHwxrB7tW6",
      "created_at" : "2022-01-04T17:55:56.52Z",
      "updated_at" : "2022-01-04T17:55:56.52Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "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_iVJKb2A4TMedsHwxrB7tW6"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_iVJKb2A4TMedsHwxrB7tW6/subscription_amounts"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules?nickname=Monthly_Subscription_Schedule&offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 10
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/subscription/subscription_schedules?nickname=:NICKNAME&subscription_type=:SUBSCRIPTION_TYPE

URL Parameters

`Parameter`	Description
:NICKNAME	`Subscription Schedule` name
:SUBSCRIPTION_TYPE	`Subscription Schedule` type

Response for _INTERVAL

Field	Type	Description
`id`	string	`Subscription Schedule` ID
`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. Available types are: PERIODIC_MONTHLY, PERIODIC_YEARLY or FIXED_TIME_INTERVAL
`tags`	object	Key value pair for annotating custom metadata (e.g. order numbers)

Response for PERIODIC

Field	Type	Description
`id`	string	`Subscription Schedule` ID
`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)