Show package info

Overview

Retrieve detailed information for a single package catalog template, including its items (service/product groups), pricing, expiration settings, and active status.

Authentication

Available for Staff tokens. Directory and App tokens are supported with the X-On-Behalf-Of header set to the target business UID. Also available for Internal tokens.

Path Parameters

  • package_id (required, string) — The unique identifier (UID) of the catalog package to retrieve (e.g., "v2fvy50p8gjuvnvb").

Notes

  • This returns the catalog template definition, not a client-specific subscription. To view a client's assigned package, use GET /business/payments/v1/client_packages/{uid}.
  • Soft-deleted packages (where active is false and deleted_at is set) are still retrievable by ID but will not appear in the list endpoint with active_only filter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier (UID) of the catalog package to retrieve (e.g., "v2fvy50p8gjuvnvb").

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json