Retrieves a subscription

GET

/api/v1/subscriptions/{{subscription-id}}

Request

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://openapi1.uat.useepay.com/api/v1/subscriptions/sub_1JBQUBE5K0000' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "sub_1JBPC9HT80000",
    "recurring": {
        "interval": "month",
        "interval_count": 1,
        "unit_amount": 112,
        "total_billing_cycles": 10
    },
    "currency": "USD",
    "description": "subscription desc",
    "order": {
        "category": "Apparel and accessories",
        "products": [
            {
                "category": "Apparel and accessories",
                "code": "3414314111",
                "desc": "IPHONE 7",
                "effective_end_at": "2020-12-31T23:59:59Z",
                "effective_start_at": "2020-01-01T00:00:00Z",
                "name": "IPHONE7",
                "quantity": 5,
                "seller": {
                    "identifier": "string",
                    "name": "string"
                },
                "sku": "100004",
                "type": "physical",
                "unit_price": 100.01,
                "url": "https://example.useepay.com/product/12345"
            }
        ],
        "shipping": {
            "address": {
                "city": "Shanghai",
                "country_code": "CN",
                "postcode": "100000",
                "state": "Shanghai",
                "line1": "Pudong District"
            },
            "first_name": "John",
            "last_name": "Doe",
            "phone_number": "13800000000",
            "shipping_method": "sameday"
        }
    },
    "metadata": {
        "sid": "0001"
    },
    "status": "incomplete",
    "livemode": null,
    "prorate": null,
    "merchant_no": "500000000007264",
    "app_id": "www.demo.com",
    "create_at": "2024-10-28T03:49:28Z",
    "modify_at": "2024-10-28T03:49:28Z",
    "customer_id": "cus_1JA7UDDQG3800",
    "cancel_at_period_end": null,
    "current_period_end": null,
    "current_period_start": null,
    "latest_invoice": null,
    "first_invoice_id": null,
    "cancel_at": null,
    "canceled_at": null,
    "collection_method": "charge_automatically",
    "days_until_due": null,
    "ended_at": null,
    "cancellation_details": null,
    "invoice_now": null
}

Modified at 2024-12-27 05:59:15

Create a subscription

Update a subscription