Deprecated API Reference

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

Fetch Subscription Enrollment by Merchant ID

List all previously created Subscription Enrollments by Merchant ID.

Copy

Copied

curl https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/?merchant_id=MUucec6fHeaWo3VHYoSkUySM \
  -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_enrollments" : [ {
      "id" : "SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV",
      "created_at" : "2022-01-27T07:44:09.08Z",
      "updated_at" : "2022-01-27T07:44:09.08Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUucec6fHeaWo3VHYoSkUySM",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM"
        },
        "schedule" : {
          "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"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?merchant_id=MUucec6fHeaWo3VHYoSkUySM&offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 1
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?merchant=:MERCHANT_ID

URL Parameters

`Parameter`	Description
:MERCHANT_ID	ID of the `Merchant`

Response

Field	Type	Description
`id`	string	`Subscription Enrollment` ID
`created_at`	string	Timestamp of when the `Subscription Enrollment` was created
`updated_at`	string	Timestamp of when the `Subscription Enrollment` was last updated
`created_by`	string	`User` ID
`ended_at`	string	When the subscription will end in DateTime format
`merchant`	string	ID of the `Merchant`
`nickname`	string	Name of the `Subscription Enrollment`
`started_at`	string	When the subscription will begin in DateTime format
`tags`	object	Key value pair for annotating custom metadata (e.g. order numbers)