Apply coupon to customer

POST

/v1/coupons/apply

Apply a coupon to a customer.

Request Body ^required

ApplyCouponRequest

object

coupon_code

required

Coupon Code

string

customer_id

required

Customer Id

string format: uuid

amount_cents

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

>= 3 characters <= 3 characters

null

null

percentage_rate

Any of:

number

number

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

Responses

201

Successful Response

AppliedCouponResponse

object

id

required

Id

string format: uuid

coupon_id

required

Coupon Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

amount_cents

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

null

null

percentage_rate

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

frequency

required

Frequency

string

frequency_duration

Any of:

integer

integer

null

null

frequency_duration_remaining

Any of:

integer

integer

null

null

status

required

Status

string

terminated_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

400

Coupon is not active

401

Unauthorized

404

Coupon or customer not found

409

Coupon already applied to this customer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object