Sign in

v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
offers

Retrieve an offer

get/offers/{id}

Path parameters

idstring required

Offer ID to retrieve

Response

OK

idstring required
type'change_frequency' | 'change_plan' | 'coupon' | 'custom' | 'downgrade' | 'dunning' | 'free_gift' | 'modify_subscription' | 'pause_subscription' | 'product_swap' | 'purchase' | 'reactivate' | 'reschedule_order' | 'trial_extension' | 'upgrade' required
goal'retention' | 'conversion' | 'reactivation' required
context'cancellation_flow' | 'conversion_campaign' | 'landing_page' required
namestring required
metadataobject required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
  "name": "40% off",
  "details": {
    "interval": "month",
    "interval_count": 3
  }
}