Create subscription

POST

/v1/billing/subscriptions

Creates a subscription.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 72 hours.

示例值:

Prefer

string

必需

The preferred server response upon successful completion of the request. Value is:

return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
return=representation. The server returns a complete resource representation, including the current state of the resource.

示例值:

Body 参数application/json

plan_id

string

必需

start_time

string

必需

shipping_amount

object

必需

currency_code

string

必需

value

string

必需

subscriber

object

必需

name

object

必需

email_address

string

必需

shipping_address

object

必需

application_context

object

必需

brand_name

string

必需

locale

string

必需

shipping_preference

string

必需

user_action

string

必需

payment_method

object

必需

return_url

string

必需

cancel_url

string

必需

示例

{
    "plan_id": "{{billing_plan_id}}",
    "start_time": "{{tomorrow}}",
    "shipping_amount": {
        "currency_code": "USD",
        "value": "10.00"
    },
    "subscriber": {
        "name": {
            "given_name": "FooBuyer",
            "surname": "Jones"
        },
        "email_address": "foobuyer@example.com",
        "shipping_address": {
            "name": {
                "full_name": "John Doe"
            },
            "address": {
                "address_line_1": "2211 N First Street",
                "address_line_2": "Building 17",
                "admin_area_2": "San Jose",
                "admin_area_1": "CA",
                "postal_code": "95131",
                "country_code": "US"
            }
        }
    },
    "application_context": {
        "brand_name": "Example Inc",
        "locale": "en-US",
        "shipping_preference": "SET_PROVIDED_ADDRESS",
        "user_action": "SUBSCRIBE_NOW",
        "payment_method": {
            "payer_selected": "PAYPAL",
            "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
        },
        "return_url": "https://example.com/return",
        "cancel_url": "https://example.com/cancel"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-m.sandbox.paypal.com/v1/billing/subscriptions' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "plan_id": "{{billing_plan_id}}",
    "start_time": "{{tomorrow}}",
    "shipping_amount": {
        "currency_code": "USD",
        "value": "10.00"
    },
    "subscriber": {
        "name": {
            "given_name": "FooBuyer",
            "surname": "Jones"
        },
        "email_address": "foobuyer@example.com",
        "shipping_address": {
            "name": {
                "full_name": "John Doe"
            },
            "address": {
                "address_line_1": "2211 N First Street",
                "address_line_2": "Building 17",
                "admin_area_2": "San Jose",
                "admin_area_1": "CA",
                "postal_code": "95131",
                "country_code": "US"
            }
        }
    },
    "application_context": {
        "brand_name": "Example Inc",
        "locale": "en-US",
        "shipping_preference": "SET_PROVIDED_ADDRESS",
        "user_action": "SUBSCRIBE_NOW",
        "payment_method": {
            "payer_selected": "PAYPAL",
            "payee_preferred": "IMMEDIATE_PAYMENT_REQUIRED"
        },
        "return_url": "https://example.com/return",
        "cancel_url": "https://example.com/cancel"
    }
}'

返回响应

🟢201201 - Create Subscription With Minimal Request

application/json

Body

status

string

必需

status_update_time

string

必需

string

必需

plan_id

string

必需

start_time

string

必需

quantity

string

必需

subscriber

object

必需

create_time

string

必需

plan_overridden

boolean

必需

links

array [object {3}]

必需

href

string

必需

rel

string

必需

method

string

必需

示例

{
    "status": "APPROVAL_PENDING",
    "status_update_time": "2023-04-10T16:57:03Z",
    "id": "I-3K9N0AULDABT",
    "plan_id": "P-3U540844AX2546419MQYHLVQ",
    "start_time": "2023-04-10T16:57:03Z",
    "quantity": "1",
    "subscriber": {},
    "create_time": "2023-04-10T16:57:03Z",
    "plan_overridden": false,
    "links": [
        {
            "href": "https://www.sandbox.paypal.com/webapps/billing/subscriptions?ba_token=BA-6NS85567LW887234V",
            "rel": "approve",
            "method": "GET"
        },
        {
            "href": "https://api-m.sandbox.paypal.com/v1/billing/subscriptions/I-3K9N0AULDABT",
            "rel": "edit",
            "method": "PATCH"
        },
        {
            "href": "https://api-m.sandbox.paypal.com/v1/billing/subscriptions/I-3K9N0AULDABT",
            "rel": "self",
            "method": "GET"
        }
    ]
}

🟢201201 - Create Subscription With Detailed Request

🟠400400 Bad Request - Invalid Parameter Value

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Billing Plan Not Found

🟠422422 Unprocessable Entity - Subscription Can Not Have Quantity

修改于 2023-08-16 07:18:59

Update pricing

Show subscription details