GET /api/v1/services/:serviceId/plans — List Payment Plans

Use this endpoint to retrieve all payment plans attached to a given service. The response is an array of plan objects ordered by createdAt descending, so the most recently created plan appears first. Use the plan IDs returned here when you create checkout sessions or need to audit your pricing configuration.

GET https://api.retempo.xyz/api/v1/services/:serviceId/plans

Path Parameters

string

required

The unique identifier of the service whose plans you want to list. You can find this ID in the list services or get service response. Passing an ID that does not exist returns a 404.

Response

A successful request returns HTTP 200 OK with a plans array. If the service exists but has no plans, the array is empty.

{
  "plans": [
    {
      "id": "clz1plan567",
      "serviceId": "clz1abc2def3ghi4",
      "name": "Pro Monthly",
      "description": "Full access, billed monthly",
      "pricingType": "FIXED_RECURRING",
      "billingInterval": "MONTH",
      "amount": "49.000000",
      "currency": "USDC",
      "createdAt": "2025-06-01T10:05:00.000Z",
      "updatedAt": "2025-06-01T10:05:00.000Z"
    }
  ]
}

array

An array of payment plan objects for the specified service, ordered by createdAt descending.

Show plan object fields

string

The unique identifier for the plan. Pass this to the checkout session endpoint to let subscribers enroll.

string

The ID of the service this plan belongs to.

string

The display name of the plan.

string

The plan description, if one was provided at creation.

string

The pricing model: FIXED_RECURRING, USAGE_BASED, or ONE_TIME.

string

The billing cadence: MONTH, WEEK, DAY, or NONE.

string

The USDC charge amount stored with six decimal places of precision (e.g. "49.000000").

string

The settlement currency. Currently always USDC.

string

ISO 8601 timestamp recording when the plan was created.

string

ISO 8601 timestamp recording when the plan was last modified.

Error Responses

Status	Message	Condition
`404 Not Found`	`Referenced database record was not found.`	No service exists for the provided `serviceId`.

Example

Replace clz1abc2def3ghi4 with your actual service ID:

curl https://api.retempo.xyz/api/v1/services/clz1abc2def3ghi4/plans

Example response:

{
  "plans": [
    {
      "id": "clz1plan567",
      "serviceId": "clz1abc2def3ghi4",
      "name": "Pro Monthly",
      "description": "Full access, billed monthly",
      "pricingType": "FIXED_RECURRING",
      "billingInterval": "MONTH",
      "amount": "49.000000",
      "currency": "USDC",
      "createdAt": "2025-06-01T10:05:00.000Z",
      "updatedAt": "2025-06-01T10:05:00.000Z"
    }
  ]
}

Example 404 response:

{
  "error": "Referenced database record was not found."
}

To add a new plan to a service, use the Create Plan endpoint. To inspect a service and all its plans in one call, use Get Service.

Overview

Services

Payment Plans

Checkout & Invoicing

Settlements

GET /api/v1/services/:serviceId/plans — List Payment Plans

Path Parameters

Response

Error Responses

Example

​Path Parameters

​Response

​Error Responses

​Example

Path Parameters

Response

Error Responses

Example