get/svc/payment/api/v1/openapi/recurring_payments/orders/list

Get plan orders

Retrieves the orders associated with a specified recurring plan using the Advanced query DSL.

Query parameters

filter

string

Filter conditions in query DSL

offset

number

Page offset

limit

number

Page limit on line count

Header parameters

Signature

string

Example: good

Credential

string

Example: {{credential}}

x-request-id

string

Example: {{$string.uuid}}

x-i18n-lang

string

Example: zh-CN

Content-typerequired

string

Example: application/json

Responses

coderequired

integer

Response code

required

array<object>

Recurring orders

required

object

required

object

required

object

Billing cycle associated with this order

messagerequired

string

Response message

Request · cURL

curl -X GET "https://api.wonder.app/svc/payment/api/v1/openapi/recurring_payments/orders/list" \
  -H "Content-Type: application/json" \
  -H "Signature: <Signature>" \
  -H "Credential: <Credential>" \
  -H "x-request-id: <x-request-id>" \
  -H "x-i18n-lang: <x-i18n-lang>"

Response 200

{
  "code": 0,
  "data": [
    {
      "order": {
        "note": "string",
        "state": "string",
        "amount": 0,
        "timeout": {
          "url": "string",
          "timer": "string"
        },
        "currency": "string",
        "auth_code": "string",
        "paid_total": 0,
        "order_number": "string",
        "redirect_url": "string",
        "reference_number": "string",
        "correspondence_state": "string",
        "default_payment_token": "string",
        "default_collection_method": "string"
      },
      "customer": {
        "name": "string",
        "uuid": "string",
        "email": "string",
        "phone": "string",
        "reference_number": "string",
        "default_payment_token": {
          "state": "string",
          "token": "string",
          "default": true,
          "error_msg": "string",
          "error_code": "string",
          "token_type": "CreditCard",
          "verify_url": "string",
          "credit_card": {
            "brand": "string",
            "number": "string",
            "exp_year": "string",
            "exp_month": "string",
            "holder_name": "string",
            "billing_currency": "string"
          },
          "verify_uuid": "string"
        },
        "default_payment_method": "string"
      },
      "recurring_cycle": {
        "discount_amount": 0,
        "recurring_items": [
          {
            "id": "string",
            "label": "string",
            "price": 0,
            "currency": "string",
            "created_at": "string",
            "deleted_at": "string",
            "updated_at": "string",
            "description": "string",
            "reference_id": "string"
          }
        ],
        "recurring_billing_config": {
          "id": "string",
          "created_at": "string",
          "deleted_at": "string",
          "updated_at": "string",
          "description": "string",
          "billing_type": "string",
          "billing_month": 0,
          "interval_count": 0,
          "billing_interval": "string",
          "billing_day_of_month": 0,
          "billing_proration_enabled": true
        }
      }
    }
  ],
  "message": "string"
}

PreviousGet a recurring order Next Get plans