Sign in

v1

latestOpenAPI 3.1.02026-07-245644294.6 KB
Subscriptions

Create warranty event

Track a warranty event (repair or replacement) for a subscription. Creates a subscription event of type "warranty" with the provided details. Triggers a warranty usage notification email to the shopper.

post/api/public/v1/subscriptions/{id}/warranty_event

Path parameters

idstring required

Subscription ID (integer)

Headers

Authorizationstring required

Request body

type'repair' | 'replacement' required

Warranty event sub-type

namestring

Name of the warranty claim

descriptionstring

Description of the warranty claim

charged_amountinteger required

Amount charged in cents

product_idstring required

Product identifier (cart item ID or UUID)

Example request

{
  "type": "repair",
  "name": "Daños o rotura",
  "description": "Se cayeron y se rompieron",
  "charged_amount": 2500,
  "product_id": "39211827-03e6-4e7b-85c0-9228ea5c3f5c"
}

Response

warranty event created successfully