GEgetlago
coupons
customers

Delete an applied coupon

Changed on

This endpoint is used to delete a specific coupon that has been applied to a customer.

delete/customers/{external_customer_id}/applied_coupons/{applied_coupon_id}

Request

Path parameters

external_customer_idstring required
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

The customer external unique identifier (provided by your own application)

applied_coupon_idstring uuid required
Example:1a901a90-1a90-1a90-1a90-1a901a901a90

Unique identifier of the applied coupon, created by Lago.

Response

Successful response

Example response

{
  "applied_coupon": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_coupon_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "coupon_code": "startup_deal",
    "coupon_name": "Startup Deal",
    "coupon_description": "I am a coupon description",
    "coupon_status": "active",
    "coupon_deleted_at": "2022-04-29T08:59:51Z",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "status": "active",
    "amount_cents": 2000,
    "amount_cents_remaining": 50,
    "amount_currency": "USD",
    "frequency": "recurring",
    "frequency_duration": 3,
    "frequency_duration_remaining": 1,
    "expiration_at": "2022-04-29T08:59:51Z",
    "created_at": "2022-04-29T08:59:51Z",
    "terminated_at": "2022-04-29T08:59:51Z"
  }
}

Changes

  • fce1879654d8Revision changes
    • warning

      added the new SYP enum value to the / response property for the response status

    • warning

      added the new TND enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      the response property / became required for the status

  • 24e860ade740Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status