Update an offer

Updates an application's offer by setting the values of the provided parameters.

Any parameters not included in the request payload will be left unchanged.

Authorized scopes:

  • owner
  • admin:full
  • admin:limited
  • application:update
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The id of the application.

string
required

The id of the offer.

Body Params
string

Unique id defined by the Application. Once set, the id cannot be changed.

string

The id of the discount that should be associated with this offer. Any updates to the underlying discount will also be propagated to the offer.

integer

Unix timestamp of when the offer starts (in seconds since the Unix epoch). If set to 0, the offer will start immediately.

integer

Unix timestamp of when the offer ends (in seconds since the Unix epoch). If set to 0, the offer will never end.

integer

The maximum number of times the offer can be redeemed. If set to 0, the offer can be redeemed an unlimited number of times. This field is ignored if require_code is true.

boolean

If this offer should be made available to active accounts.

boolean

If this offer should be made available to accounts that have cancelled (will not auto-renew but still have access).

boolean

If this offer should be made available to new accounts (signups).

boolean

If this offer should be made available to winbacks (churned accounts starting a new subscription).

Headers
integer
Responses

401

Unauthorized

Language
Credentials
Bearer
token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json