Update a payment link - 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

active

boolean

optional

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

line_items

array [object {2}]

optional

A list of items the customer is purchasing. Each line item represents an item being sold. Up to 20 line items are supported.

id

string

required

The ID of an existing line item on the payment link.

quantity

string

optional

The quantity of the line item being purchased.

after_completion

object

optional

Behavior after the purchase is complete.

type

enum<string>

optional

The specified behavior after the purchase is complete.

Allowed values:

redirecthosted_confirmation

hosted_confirmation

object

optional

Configuration when type=hosted_confirmation.

redirect

object

optional

Configuration when type=redirect.

billing_address_collection

enum<string>

optional

Configuration for collecting the customer’s billing address.

Allowed values:

autorequired

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.

phone_number_collection

object

optional

Controls phone number collection settings during checkout.

enabled

boolean

optional

If true, a phone number will be collected during checkout.

shipping_address_collection

object

optional

Configuration for collecting the customer’s shipping address.

allowed_countries

array[string]

optional

An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.

Example

{
    "active": true,
    "line_items": [
        {
            "id": "string",
            "quantity": "string"
        }
    ],
    "after_completion": {
        "type": "redirect",
        "hosted_confirmation": {
            "custom_message": "string"
        },
        "redirect": {
            "url": "string"
        }
    },
    "billing_address_collection": "auto",
    "metadata": {},
    "phone_number_collection": {
        "enabled": true
    },
    "shipping_address_collection": {
        "allowed_countries": [
            "string"
        ]
    }
}

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/payment_links/id' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "active": true,
    "line_items": [
        {
            "id": "string",
            "quantity": "string"
        }
    ],
    "after_completion": {
        "type": "redirect",
        "hosted_confirmation": {
            "custom_message": "string"
        },
        "redirect": {
            "url": "string"
        }
    },
    "billing_address_collection": "auto",
    "metadata": {},
    "phone_number_collection": {
        "enabled": true
    },
    "shipping_address_collection": {
        "allowed_countries": [
            "string"
        ]
    }
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object, like 'plink_xxxx'.

object

string

optional

"payment_link"

active

boolean

optional

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

after_completion

object

optional

Behavior after the purchase is complete.

type

enum<string>

optional

The specified behavior after the purchase is complete.

Allowed values:

redirecthosted_confirmation

hosted_confirmation

object

optional

Configuration when type=hosted_confirmation.

redirect

object

optional

Configuration when type=redirect.

billing_address_collection

enum<string>

optional

Configuration for collecting the customer’s billing address.

Allowed values:

autorequired

currency

string

optional

Three-letter ISO currency code. Must be a supported currency.

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.

phone_number_collection

object

optional

Controls phone number collection settings during checkout.

enabled

boolean

optional

If true, a phone number will be collected during checkout.

shipping_address_collection

object

optional

Configuration for collecting the customer’s shipping address.

allowed_countries

array[string]

optional

An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.

url

string

optional

The public URL that can be shared with customers.

line_items

object

optional

The line items representing what is being sold. This field is not included by default. This field is not included by default. To include it in the response, expand the line_items field.

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {8}]

optional

created

integer

optional

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

Example

{
    "id": "string",
    "object": "string",
    "active": true,
    "after_completion": {
        "type": "redirect",
        "hosted_confirmation": {
            "custom_message": "string"
        },
        "redirect": {
            "url": "string"
        }
    },
    "billing_address_collection": "auto",
    "currency": "string",
    "livemode": true,
    "metadata": {},
    "phone_number_collection": {
        "enabled": true
    },
    "shipping_address_collection": {
        "allowed_countries": [
            "string"
        ]
    },
    "url": "string",
    "line_items": {
        "object": "\"list\"",
        "url": "string",
        "has_more": true,
        "data": [
            {
                "id": "string",
                "object": "string",
                "amount_subtotal": "string",
                "amount_total": "string",
                "currency": "string",
                "description": "string",
                "price": {
                    "id": "string",
                    "object": "string",
                    "active": true,
                    "billing_scheme": "per_unit",
                    "created": 0,
                    "currency": "string",
                    "livemode": true,
                    "lookup_key": "string",
                    "metadata": {},
                    "nickname": "string",
                    "product": "string",
                    "type": "one_time",
                    "unit_amount": 0,
                    "recurring": {
                        "interval": "day",
                        "interval_count": 0,
                        "usage_type": "licensed"
                    },
                    "tiers": [
                        {
                            "up_to": "string",
                            "flat_amount": "string",
                            "unit_amount": "string"
                        }
                    ]
                },
                "quantity": "string"
            }
        ]
    },
    "created": 0
}