List Subscription Enrollments on a Schedule

Retrieve a list of Subscription Enrollments for a specific subscription_schedule.

Request
path Parameters
subscription_schedule_id
required
string

The ID of the subscription_schedule.

Responses
200

List of subscription_enrollment objects

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of Subscription Enrollment resources.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_schedules/{subscription_schedule_id}/subscription_enrollments
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_m77bRhJJ83oj9kBP3sYcv/subscription_enrollments \
  -H "Content-Type: application/vnd.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{}

Create a Subscription Enrollment

Create a subscription_enrollment.

A subscription_enrollment details which Merchant gets charged, to what schedule, and when the subscription will start. The subscription_enrollment must be associated with a Subscription Schedule.

Request
path Parameters
subscription_schedule_id
required
string

The ID of the subscription_schedule.

Request Body schema: application/hal+json
ended_at
string or null non-empty

When the subscription_enrollment will end in DateTime format. If left null, the Fee will continue in perpetuity and won't end.

merchant
required
string non-empty

ID of the Merchant resource.

nickname
required
string non-empty

Human readable name.

started_at
required
string non-empty

When the subscription_enrollment will begin in DateTime format. The start date must be a future date.

object

Key value pair for annotating custom meta data (e.g. order numbers).

Responses
200

Single subscription_enrollment resource

Response Schema: application/hal+json
id
string non-empty

ID of the subscription_enrollment.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

created_by
string non-empty

ID of the User who created the subscription_enrollment.

ended_at
string or null

When the subscription_enrollment will end in DateTime format.

merchant
string non-empty

ID of the Merchant resource.

nickname
string

Human readable name.

started_at
string non-empty

When the subscription_enrollment will begin in DateTime format.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

post/subscription/subscription_schedules/{subscription_schedule_id}/subscription_enrollments
Request samples
Response samples
application/hal+json
{}

List Subscription Enrollments

Retrieve a list of Subscription Enrollments.

Responses
200

List of subscription_enrollment objects

Response Schema: application/hal+json
object

Details the page that's returned.

object

List of Subscription Enrollment resources.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_enrollments
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_enrollments \
  -H "Content-Type: application/vnd.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{}

Update a Subscription Enrollment

Update the details of a subscription_enrollment.

Request
path Parameters
subscription_enrollment_id
required
string

The ID of the subscription_enrollment.

Request Body schema: application/hal+json
id
string

ID of the subscription_enrollment.

Responses
200

Single subscription_enrollment resource

Response Schema: application/hal+json
id
string non-empty

ID of the subscription_enrollment.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

created_by
string non-empty

ID of the User who created the subscription_enrollment.

ended_at
string or null

When the subscription_enrollment will end in DateTime format.

merchant
string non-empty

ID of the Merchant resource.

nickname
string

Human readable name.

started_at
string non-empty

When the subscription_enrollment will begin in DateTime format.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

put/subscription/subscription_enrollments/{subscription_enrollment_id}
Request samples
Response samples
application/hal+json
{}

Fetch a Subscription Enrollment

Retrieve the details of a subscription_enrollment.

Request
path Parameters
subscription_enrollment_id
required
string

The ID of the subscription_enrollment.

query Parameters
merchant
string

Filter by the object's Merchant ID.

Responses
200

Single subscription_enrollment resource

Response Schema: application/hal+json
id
string non-empty

ID of the subscription_enrollment.

created_at
string <date-time>

Timestamp of when the object was created.

updated_at
string <date-time>

Timestamp of when the object was last updated.

created_by
string non-empty

ID of the User who created the subscription_enrollment.

ended_at
string or null

When the subscription_enrollment will end in DateTime format.

merchant
string non-empty

ID of the Merchant resource.

nickname
string

Human readable name.

started_at
string non-empty

When the subscription_enrollment will begin in DateTime format.

subscription_schedule
string non-empty

ID of the Subscription Schedule.

object

Key value pair for annotating custom meta data (e.g. order numbers).

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/subscription/subscription_enrollments/{subscription_enrollment_id}
Request samples
curl https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_Yxwo2Vb6oj97m3PuW9TxQ \
  -H "Content-Type: application/vnd.json+api" \
  -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
Response samples
application/hal+json
{}

Delete a Subscription Enrollment

Remove a subscription_enrollment.

Per the JSON API for deleting a resource, our API doesn't have a response body when removing a Subsciption Enrollment.

Request
path Parameters
subscription_enrollment_id
required
string

The ID of the subscription_enrollment.

Responses
204

No content

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

delete/subscription/subscription_enrollments/{subscription_enrollment_id}
Request samples
Response samples
application/hal+json
{
  • "total": 0,
  • "_embedded": {
    • "errors": [
      ]
    }
}