UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
    • Intergration
      • Welcome to the UseePay Demo Page
      • About Payment Methods
        • Card
        • Apple Pay Web Integration (API Integration)
        • Apple Pay(Hosted Checkout)
        • Google Pay
        • Klarna
        • Naver pay
        • Kakao Pay
        • Toss Pay
        • Payco
        • Affirm
        • Blik
        • trustly
      • subscription
        • Get started with Subscription
      • online payment
        • Get started with online payments
      • Payment Capabilities
        • Adaptive Price
    • developer
      • Introduction
      • Authentication
      • Errors
      • error code
        • last_payment_error documentation
      • Best Integration
        • Quickly create a paymentIntent for a subscription
        • Auto-Charge Subscription Guide
      • Payment Intents
        • Payment Intent Overview
        • Quickly create a paymentIntent
        • Create a PaymentIntent
        • Retrieve a PaymentIntent
        • Update a PaymentIntent
        • Confirm a PaymentIntent
        • Cancel a PaymentIntent
        • Capture a PaymentIntent
        • List all payment intents
      • Customers
        • Create a customer
        • Retrieves a customer
        • Update a customer
        • List all customers
      • Subscriptions
        • Create a subscription
        • Retrieves a subscription
        • Update a subscription
        • List all subscriptions
        • Cancel a subscription
      • Invoices
        • Create a invoice
        • Retrieves a invoice
        • List all invoices
        • Pay a invoice
      • Payment Methods
        • Create a payment method
        • Retieve Payment Method Session
        • Retrieves a payment method
        • Update a payment method
        • List all payment methods
      • Mandates
        • Create a mandate
        • Retrieves a mandate
        • List all mandates
      • Refunds
        • Create a refund
        • Retrieves a refund
        • List all refunds
      • Webhooks
        • Webhook events
        • Webhook Activation/Signature Verification Steps
        • Create a webhook
        • Retrieves a webhook
        • Update a webhook
        • List all webhooks
      • Embedded Checkout
        • Payment Elements
      • case
      • objects
      • About Testing
        • Test Cards
        • ApplePay&GooglePay
      • Payment Method Configuration
        • Retieve Payment Method Configuration
      • Schemas
        • Customer
        • Address
        • Shipping
        • Error
        • PaymentIntentCreateRequest
        • DeviceData
        • Order
        • Product
        • PaymentMethodOptions
        • RiskControlOptions
        • Mandate
        • PaymentIntent
        • PaymentMethod
        • Billing
        • Card
        • AliPay
        • Wallet
        • Klarna
        • WechatPay
        • Refund
        • Subscription
        • Recurring
        • PriceData
        • SubscriptionItem
        • Invoice
        • NextAction
        • Webhook
        • CollectableOptions
        • PaymentLink
        • last_payment_error
        • discount_period_config
    • message
      • Messaging Element
    • FAQ
      • Unable to receive Webhook notifications
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0
    UseePay PortalMechant Dashboard
    Product Docs
    Product Docs
    • V2.0
    • V1.0

    Subscription

    {
        "id": "string",
        "customer_id": "string",
        "recurring": {
            "interval": "day",
            "interval_count": 0,
            "unit_amount": 0,
            "total_billing_cycles": 0
        },
        "currency": "string",
        "description": "string",
        "order": {
            "category": "string",
            "products": [
                {
                    "desc": "string",
                    "effective_end_at": "string",
                    "effective_start_at": "string",
                    "name": "string",
                    "quantity": 0,
                    "seller": {
                        "identifier": "string",
                        "name": "string"
                    },
                    "sku": "string",
                    "type": "string",
                    "price": 0,
                    "url": "string"
                }
            ],
            "shipping": {
                "address": {
                    "country": "string",
                    "city": "string",
                    "postcode": "string",
                    "state": "string",
                    "line1": "string",
                    "line2": "string"
                },
                "name": "string",
                "phone": "string",
                "first_name": "string",
                "last_name": "string",
                "shipping_method": "string"
            }
        },
        "metadata": {},
        "status": "incomplete",
        "livemode": true,
        "prorate": true,
        "merchant_no": "string",
        "app_id": "string",
        "create_at": "string",
        "modify_at": "string",
        "cancel_at_period_end": true,
        "current_period_end": "string",
        "current_period_start": "string",
        "default_payment_method": "string",
        "latest_invoice": {
            "id": "string",
            "collection_method": "charge_automatically",
            "currency": "string",
            "customer_id": "string",
            "description": "string",
            "metadata": {},
            "hosted_invoice_url": "string",
            "subscription_id": "string",
            "payment_intent": {
                "id": "string",
                "code": "string",
                "source": "string",
                "message": "string",
                "amount": 0,
                "currency": "string",
                "status": "requires_payment_method",
                "customer_id": "string",
                "customer": {
                    "merchant_customer_id": "string",
                    "phone": "string",
                    "address": {
                        "country": "string",
                        "city": "string",
                        "postcode": "string",
                        "state": "string",
                        "line1": "string",
                        "line2": "string"
                    },
                    "description": "string",
                    "metadata": {},
                    "shipping": {
                        "address": {
                            "country": "string",
                            "city": "string",
                            "postcode": "string",
                            "state": "string",
                            "line1": "string",
                            "line2": "string"
                        },
                        "name": "string",
                        "phone": "string",
                        "first_name": "string",
                        "last_name": "string",
                        "shipping_method": "string"
                    }
                },
                "description": "string",
                "order": {
                    "category": "string",
                    "products": [
                        {
                            "desc": "string",
                            "effective_end_at": "string",
                            "effective_start_at": "string",
                            "name": "string",
                            "quantity": 0,
                            "seller": {
                                "identifier": "string",
                                "name": "string"
                            },
                            "sku": "string",
                            "type": "string",
                            "price": 0,
                            "url": "string"
                        }
                    ],
                    "shipping": {
                        "address": {
                            "country": "string",
                            "city": "string",
                            "postcode": "string",
                            "state": "string",
                            "line1": "string",
                            "line2": "string"
                        },
                        "name": "string",
                        "phone": "string",
                        "first_name": "string",
                        "last_name": "string",
                        "shipping_method": "string"
                    }
                },
                "metadata": {},
                "confirm": true,
                "auto_capture": true,
                "merchant_order_id": "string",
                "invoice_id": "string",
                "captured_amount": 0,
                "available_payment_method_types": [
                    "string"
                ],
                "payment_method_options": {
                    "type": "card",
                    "card": {
                        "authorization_type": "string",
                        "auto_capture": true,
                        "three_ds_action": "string"
                    }
                },
                "cancellation_reason": "string",
                "cancelled_at": "string",
                "next_action": {
                    "type": "string",
                    "redirect": {
                        "contentType": "string",
                        "method": "string",
                        "url": "string"
                    },
                    "alipay_redirect": {
                        "native_data": "string",
                        "native_url": "string",
                        "return_url": "string",
                        "url": "string"
                    },
                    "alipay_qrcode_display": {
                        "data": "string",
                        "hosted_instructions_url": "string",
                        "image_data_url": "string",
                        "image_url_png": "string",
                        "image_url_svg": "string"
                    },
                    "oxxo_display": {
                        "expires_after": "string",
                        "hosted_voucher_url": "string",
                        "number": "string"
                    },
                    "boleto_display": {
                        "expires_at": "string",
                        "hosted_voucher_url": "string",
                        "number": "string",
                        "pdf": "string"
                    },
                    "dcc_data": {
                        "amount": 0,
                        "client_rate": 0,
                        "currency": "string",
                        "currency_pair": "string",
                        "rate_expiry": "string",
                        "rate_timestamp": "string"
                    },
                    "data": {}
                },
                "return_url": "string",
                "client_secret": "string",
                "payment_method_id": "string",
                "mandate_id": "string",
                "last_payment_error": {
                    "last_payment_error": {
                        "code": "string",
                        "decline_code": "string",
                        "message": "string",
                        "type": "card_error"
                    }
                }
            },
            "default_payment_method": "string",
            "days_until_due": 0,
            "due_date": "string",
            "effective_at": "string",
            "footer": "string",
            "number": "string",
            "total_amount": 0,
            "period_end": "string",
            "period_start": "string",
            "status": "draft",
            "merchant_no": "string",
            "app_id": "string",
            "create_at": "string",
            "modify_at": "string"
        },
        "first_invoice_id": "string",
        "cancel_at": "string",
        "canceled_at": "string",
        "collection_method": "charge_automatically",
        "days_until_due": 0,
        "ended_at": "string",
        "cancellation_details": {
            "comment": "string",
            "feedback": "customer_service"
        },
        "invoice_now": true
    }
    Built with