Create a Product - WooshPay OpenAPI

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 *****************

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

name

string

required

The product’s name, meant to be displayable to the customer.

active

boolean

optional

Whether the product is currently available for purchase. Defaults to true.

description

string

optional

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

url

string

optional

A URL of a publicly-accessible webpage for this product.

images

array[string]

optional

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

Example

{
  "id": null,
  "name": "taiwan fengli",
  "active": true,
  "description": "very delicious",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "url": "www.baidu.com"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/products' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "id":null,
    "name":"taiwan fengli",
    "active":true,
    "description":"very delicious",
    "metadata":{
        "key1":"value1",
        "key2":"value2"
    },
    "url":"www.baidu.com"
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object, like 'prod_xxx'.

object

string

optional

'product'

active

boolean

optional

Whether the product is currently available for purchase.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

description

string

optional

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

images

array[string]

optional

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

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

required

The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

updated

integer

optional

Time at which the object was last updated. Measured in seconds since the Unix epoch.

url

string

optional

A URL of a publicly-accessible webpage for this product.

Example

{
  "id": "string",
  "object": "string",
  "active": true,
  "created": 0,
  "description": "string",
  "images": [
    "string"
  ],
  "livemode": true,
  "metadata": {},
  "name": "string",
  "updated": 0,
  "url": "string"
}