WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Promotion Code
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
      POST
    • Update a promotion code
      POST
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Promotion Code

Update a promotion code

Developing
POST
/v1/promotion_codes/{id}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
active
boolean 
optional
Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
Example
{
    "active": true,
    "metadata": {}
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/promotion_codes/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "active": true,
    "metadata": {}
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object.
object
string 
optional
String representing the object’s type. Objects of the same type share the same value.
active
boolean 
optional
Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
code
string 
optional
The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
coupon
object (Coupons) 
optional
Hash describing the coupon for this promotion code.
id
string 
optional
Unique identifier for the object.
amount_off
integer  | null 
optional
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
currency
string  | null 
optional
If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
duration
enum<string> 
optional
One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
Allowed values:
foreveroncerepeating
duration_in_months
integer 
optional
Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
duration_in_weeks
string 
required
Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect.
duration_in_days
string 
required
Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect.
object
string 
optional
String representing the object’s type. Objects of the same type share the same value.
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name
string 
optional
Name of the coupon displayed to customers on for instance invoices or receipts.
percent_off
number  | null 
optional
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a 100invoice50 instead.
max_redemptions
integer  | null 
optional
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
redeem_by
integer  | null 
optional
Date after which the coupon can no longer be redeemed.
times_redeemed
integer 
optional
Number of times this coupon has been applied to a customer.
valid
boolean 
optional
Taking account of the above properties, whether this coupon can still be applied to a customer.
applies_to
object 
optional
Contains information about what this coupon applies to.
currency_options
object 
optional
Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
customer
null 
optional
The customer that this promotion code can be used by.
expires_at
null 
optional
Date at which the promotion code can no longer be redeemed.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
max_redemptions
null 
optional
Maximum number of times this promotion code can be redeemed.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
restrictions
object 
optional
Settings that restrict the redemption of the promotion code.
first_time_transaction
boolean 
optional
A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
minimum_amount
null 
optional
Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
minimum_amount_currency
null 
optional
Three-letter ISO code for minimum_amount
times_redeemed
integer 
optional
Number of times this promotion code has been used.
Example
{
    "id": "string",
    "object": "string",
    "active": true,
    "code": "string",
    "coupon": {
        "id": "string",
        "amount_off": 0,
        "currency": "string",
        "duration": "forever",
        "duration_in_months": 0,
        "duration_in_weeks": "string",
        "duration_in_days": "string",
        "object": "string",
        "created": 0,
        "livemode": true,
        "metadata": {},
        "name": "string",
        "percent_off": 0,
        "max_redemptions": 0,
        "redeem_by": 0,
        "times_redeemed": 0,
        "valid": true,
        "applies_to": {
            "products": [
                "string"
            ]
        },
        "currency_options": {
            "<currency>.amount_off": 0
        }
    },
    "created": 0,
    "customer": null,
    "expires_at": null,
    "livemode": true,
    "max_redemptions": null,
    "metadata": {},
    "restrictions": {
        "first_time_transaction": true,
        "minimum_amount": null,
        "minimum_amount_currency": null
    },
    "times_redeemed": 0
}
Previous
Create a promotion code
Next
Retrieve account's paymentmethods
Built with