Trial Eligibility

Get trial eligibility overrides

get

Retrieves all trial eligibility overrides for the specified customer.

Authorizations
Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve trial eligibility overrides for.

Example: 411486491630370816
customerIdstring · flake-idRequired

The ID of the customer to retrieve trial eligibility overrides for.

Example: 411486491630370816
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses
200

OK

application/json
get
GET /v1/stores/{storeId}/customers/{customerId}/trial-eligibility/overrides HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "pretty_id": "text",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "product_id": "411486491630370816",
    "product_name": "text",
    "product_image_url": "text",
    "created_at": "2025-09-13T13:13:05.296Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "expires_at": "2025-09-13T13:13:05.296Z",
    "used_at": "2025-09-13T13:13:05.296Z",
    "used_on_trial_id": "411486491630370816",
    "note": "text",
    "deleted_at": "2025-09-13T13:13:05.296Z",
    "deleted_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create trial eligibility override

post

Creates a new trial eligibility override for the specified customer.

Authorizations
Path parameters
storeIdstring · flake-idRequired

The ID of the store to create the trial eligibility override for.

Example: 411486491630370816
customerIdstring · flake-idRequired

The ID of the customer to create the trial eligibility override for.

Example: 411486491630370816
Body
product_idstring · flake-idRequiredExample: 411486491630370816
expires_atstring · date-timeRequired
notestringOptional
Responses
200

OK

application/json
post
POST /v1/stores/{storeId}/customers/{customerId}/trial-eligibility/overrides HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "product_id": "411486491630370816",
  "expires_at": "2025-09-13T13:13:05.296Z",
  "note": "text"
}
{
  "id": "411486491630370816",
  "pretty_id": "text",
  "store_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "product_id": "411486491630370816",
  "product_name": "text",
  "product_image_url": "text",
  "created_at": "2025-09-13T13:13:05.296Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "expires_at": "2025-09-13T13:13:05.296Z",
  "used_at": "2025-09-13T13:13:05.296Z",
  "used_on_trial_id": "411486491630370816",
  "note": "text",
  "deleted_at": "2025-09-13T13:13:05.296Z",
  "deleted_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete trial eligibility override

delete

Deletes an existing trial eligibility override.

Authorizations
Path parameters
storeIdstring · flake-idRequired

The ID of the store to delete the trial eligibility override for.

Example: 411486491630370816
trialEligibilityOverrideIdstring · flake-idRequired

The ID of the trial eligibility override to delete.

Example: 411486491630370816
customerIdstringRequired
Responses
204

No Content

No content
delete
DELETE /v1/stores/{storeId}/customers/{customerId}/trial-eligibility/overrides/{trialEligibilityOverrideId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousTagsNextTrials

Was this helpful?