API ReferenceCredits
Retrieve a credits product
Retrieve a store-scoped credits product and its default variant.
AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
In: header
Path Parameters
creditProduct*integer
The creditProduct path parameter.
Header Parameters
X-STORE?string
Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://sell.app/api/v2/credit-products/0" \ -H "X-STORE: launch-lab"minimal
{
"data": {
"id": 121,
"store_id": 1,
"title": "Design credits",
"slug": "design-credits",
"description": "Credits for future design work.",
"visibility": "HIDDEN",
"type": "credits",
"is_draft": false,
"is_discoverable": false,
"section_id": null,
"default_variant": {
"id": 4322,
"price_cents": 50,
"currency": "USD",
"minimum_purchase_quantity": 1,
"maximum_purchase_quantity": null,
"quantity_increment": 1,
"stock": null,
"payment_methods": [
"STRIPE"
],
"rate_tiers": []
},
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"deleted_at": null
}
}missing_default_variant
{
"data": {
"id": 121,
"store_id": 1,
"title": "Design credits",
"slug": "design-credits",
"description": "Credits for future design work.",
"visibility": "HIDDEN",
"type": "credits",
"is_draft": false,
"is_discoverable": false,
"section_id": null,
"default_variant": null,
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"deleted_at": null,
"variant_invariant": {
"state": "missing_default_variant",
"variant_count": 0
}
}
}multiple_default_variants
{
"data": {
"id": 121,
"store_id": 1,
"title": "Design credits",
"slug": "design-credits",
"description": "Credits for future design work.",
"visibility": "HIDDEN",
"type": "credits",
"is_draft": false,
"is_discoverable": false,
"section_id": null,
"default_variant": null,
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"deleted_at": null,
"variant_invariant": {
"state": "multiple_default_variants",
"variant_count": 2
}
}
}{
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request could not be understood.",
"status": 400,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#bad-request"
}{
"type": "authentication_error",
"code": "unauthenticated",
"message": "Unauthenticated.",
"status": 401,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}{
"type": "authorization_error",
"code": "forbidden",
"message": "This action is unauthorized.",
"status": 403,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#forbidden"
}{
"type": "not_found_error",
"code": "resource_not_found",
"message": "Not Found.",
"status": 404,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}{
"type": "validation_error",
"code": "validation_failed",
"message": "The selected product variant id is invalid.",
"status": 422,
"param": "product_variant_id",
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#validation-failed",
"errors": {
"product_variant_id": [
"The selected product variant id is invalid."
]
}
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too Many Attempts.",
"status": 429,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}{
"type": "api_error",
"code": "api_error",
"message": "Server Error",
"status": 500,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#api-error"
}