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" \
    -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_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"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
      "created_at" : "2022-01-27T07:44:05.40Z",
      "updated_at" : "2022-01-27T07:44:05.40Z",
      "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_uxsUJrgbQZEXsWm9toq6gZ"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/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_kWiytjpEw7gnphwpW4nPSL",
      "created_at" : "2022-01-26T23:35:22.70Z",
      "updated_at" : "2022-01-26T23:35:22.70Z",
      "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_kWiytjpEw7gnphwpW4nPSL"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kWiytjpEw7gnphwpW4nPSL/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of",
      "created_at" : "2022-01-26T23:35:22.28Z",
      "updated_at" : "2022-01-26T23:35:22.28Z",
      "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_kUvyQgikZkbg6p2vd6U9of"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of/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_bnzrtYxdGkobVSb9MqYB28",
      "created_at" : "2022-01-13T00:04:07.95Z",
      "updated_at" : "2022-01-13T00:04:07.95Z",
      "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_bnzrtYxdGkobVSb9MqYB28"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bnzrtYxdGkobVSb9MqYB28/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS",
      "created_at" : "2022-01-13T00:04:07.57Z",
      "updated_at" : "2022-01-13T00:04:07.57Z",
      "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_bkXRUUeuN8AfR3RVNUn4vS"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS/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_qgBf9p8v3CMuDUWMGcKd8h",
      "created_at" : "2022-01-12T22:41:22.80Z",
      "updated_at" : "2022-01-12T22:41:22.80Z",
      "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_qgBf9p8v3CMuDUWMGcKd8h"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qgBf9p8v3CMuDUWMGcKd8h/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV",
      "created_at" : "2022-01-12T22:41:22.42Z",
      "updated_at" : "2022-01-12T22:41:22.42Z",
      "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_qeY8pHJiCo7e2fqmHyqKDV"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV/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_f4h5bprCWao72AYAnS89ht",
      "created_at" : "2022-01-08T00:53:50.77Z",
      "updated_at" : "2022-01-08T00:53:50.77Z",
      "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_f4h5bprCWao72AYAnS89ht"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f4h5bprCWao72AYAnS89ht/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT",
      "created_at" : "2022-01-08T00:53:50.39Z",
      "updated_at" : "2022-01-08T00:53:50.39Z",
      "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_f2CiEiZTqGju1TsCn1cesT"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT/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_7AhAXfoxykb8z3pEXPdUaK",
      "created_at" : "2022-01-07T18:39:55.52Z",
      "updated_at" : "2022-01-07T18:39:55.52Z",
      "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_7AhAXfoxykb8z3pEXPdUaK"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7AhAXfoxykb8z3pEXPdUaK/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE",
      "created_at" : "2022-01-07T18:39:55.13Z",
      "updated_at" : "2022-01-07T18:39:55.13Z",
      "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_7yDCdvjYL4gbKYmLxAUEHE"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE/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_5CWerip6qpb6eJnrENqDcD",
      "created_at" : "2022-01-06T02:19:59.07Z",
      "updated_at" : "2022-01-06T02:19:59.07Z",
      "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_5CWerip6qpb6eJnrENqDcD"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5CWerip6qpb6eJnrENqDcD/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=20&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 30
  }
}

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)