订阅查询接口

更新时间：
以 Markdown 格式查看 LLM请查看llms.txt

接口说明

接口名称：alipay.trade.subscription.query

支持第三方代理调用：本接口支持第三方开发者代用户发起调用。

适用场景

订阅场景对商户提供的查询接口。

公共请求参数

参数类型是否必选最大长度描述示例值
app_idString必选32支付宝分配给开发者的应用 ID2014072300007148
methodString必选128接口名称alipay.trade.subscription.query
formatString可选40仅支持JSONJSON
charsetString必选10请求使用的编码格式，如utf-8,gbk,gb2312等utf-8
sign_typeString必选10商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2RSA2
signString必选344商户请求参数的签名串，详见签名详见示例
timestampString必选19发送请求的时间，格式”yyyy-MM-dd HH:mm
”		2014-07-24 03:07:50
versionString必选3调用的接口版本，固定为：1.01.0
app_auth_tokenString可选40详见应用授权概述-
biz_contentString必选-请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档-

业务请求参数

参数类型是否必选最大长度描述注意事项/枚举值示例值
subscription_statusString可选64枚举值： 未完成
活跃
未完成已过期
已取消
-ACTIVE
subscription_idString可选64订阅id-20260320123156789
customer_idString必选64支付宝客户id-202603210030100000003

常见请求示例

package com.java.sdk.demo;

import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.AlipayConfig;
import com.alipay.api.request.AlipayTradeSubscriptionQueryRequest;
import com.alipay.api.response.AlipayTradeSubscriptionQueryResponse;
import com.alipay.api.domain.AlipayTradeSubscriptionQueryModel;

import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;

public class AlipayTradeSubscriptionQuery {

    public static void main(String[] args) throws AlipayApiException {
        // 初始化SDK
        AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());

        // 构造请求参数以调用接口
        AlipayTradeSubscriptionQueryRequest request = new AlipayTradeSubscriptionQueryRequest();
        AlipayTradeSubscriptionQueryModel model = new AlipayTradeSubscriptionQueryModel();
        
        // 设置订阅状态
        model.setSubscriptionStatus("ACTIVE");
        
        // 设置订阅id
        model.setSubscriptionId("20260320123156789");
        
        // 设置支付宝客户id
        model.setCustomerId("202603210030100000003");
        
        request.setBizModel(model);
        // 第三方代调用模式下请设置app_auth_token
        // request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");

        AlipayTradeSubscriptionQueryResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());

        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
            // sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
            // String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
            // System.out.println(diagnosisUrl);
        }
    }

    private static AlipayConfig getAlipayConfig() {
        String privateKey  = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF-8");
        alipayConfig.setSignType("RSA2");
        return alipayConfig;
    }
}
<?php
require_once '../aop/AopClient.php';
require_once '../aop/AopCertClient.php';
require_once '../aop/AopCertification.php';
require_once '../aop/AlipayConfig.php';
require_once '../aop/request/AlipayTradeSubscriptionQueryRequest.php';

// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeSubscriptionQueryRequest();
$model = array();

// 设置订阅状态
$model['subscription_status'] = "ACTIVE";

// 设置订阅id
$model['subscription_id'] = "20260320123156789";

// 设置支付宝客户id
$model['customer_id'] = "202603210030100000003";

$request->setBizContent(json_encode($model,JSON_UNESCAPED_UNICODE));
// 如果是第三方代调用模式，请设置app_auth_token（应用授权令牌）
$responseResult = $alipayClient->execute($request, null, "<-- 请填写应用授权令牌 -->", null);
$responseApiName = str_replace(".","_",$request->getApiMethodName())."_response";
$response = $responseResult->$responseApiName;
if(!empty($response->code)&&$response->code==10000){
    echo("调用成功");
}
else{
    echo("调用失败");
}

function getAlipayConfig()
{
    $privateKey  = '<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->';
    $alipayPublicKey = '<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->';
    $alipayConfig = new AlipayConfig();
    $alipayConfig->setServerUrl('https://openapi.alipay.com/gateway.do');
    $alipayConfig->setAppId('<-- 请填写您的AppId，例如：2019091767145019 -->');
    $alipayConfig->setPrivateKey($privateKey);
    $alipayConfig->setFormat('json');
    $alipayConfig->setAlipayPublicKey($alipayPublicKey);
    $alipayConfig->setCharset('UTF-8');
    $alipayConfig->setSignType('RSA2');
    return $alipayConfig;
}
using System;
using System.Collections.Generic;
using Aop.Api;
using Aop.Api.Request;
using Aop.Api.Response;
using Aop.Api.Domain;
using Aop.Api.Util;
namespace SdkDemoTest
{
    public class AlipayTradeSubscriptionQuery
    {
        public static void Main(string[] args) 
        {
            // 初始化SDK
            IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
            // 构造请求参数以调用接口
            AlipayTradeSubscriptionQueryRequest request = new AlipayTradeSubscriptionQueryRequest();
            AlipayTradeSubscriptionQueryModel model = new AlipayTradeSubscriptionQueryModel();
            
            // 设置订阅状态
            model.SubscriptionStatus = "ACTIVE";
            
            // 设置订阅id
            model.SubscriptionId = "20260320123156789";
            
            // 设置支付宝客户id
            model.CustomerId = "202603210030100000003";
            
            request.SetBizModel(model);
            // 第三方代调用模式下请设置app_auth_token
            // request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");

            AlipayTradeSubscriptionQueryResponse response = alipayClient.Execute(request);

            if(!response.IsError)
            {
                Console.WriteLine("调用成功");
            }
            else
            {
                Console.WriteLine("调用失败");
            }
        }

        private static AlipayConfig GetAlipayConfig()
        {
            string privateKey  = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
            string alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.ServerUrl = "https://openapi.alipay.com/gateway.do";
            alipayConfig.AppId = "<-- 请填写您的AppId，例如：2019091767145019 -->";
            alipayConfig.PrivateKey = privateKey;
            alipayConfig.Format = "json";
            alipayConfig.AlipayPublicKey = alipayPublicKey;
            alipayConfig.Charset = "UTF-8";
            alipayConfig.SignType = "RSA2";
            return alipayConfig;
        }
    }
}
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.subscription.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}' \
 -F 'biz_content={
    "subscription_status":"ACTIVE",
    "subscription_id":"20260320123156789",
    "customer_id":"202603210030100000003"
}'

公共响应参数

参数类型是否必选描述示例值
codeString必选网关返回码，详见文档40004
msgString必选网关返回码描述，详见文档Business Failed
sub_codeString可选业务返回码，参见具体的 API 接口文档-
sub_msgString可选业务返回码描述，参见具体的 API 接口文档-
signString必选签名，详见文档DZXh8eeTuAHoYE3w1J…

业务响应参数

参数类型是否必选最大长度描述注意事项/枚举值示例值
subscriptionsSubscription可选-订阅详情信息--
subscriptions.subscription_idString可选64订阅id-20260320123156789
subscriptions.customer_idString可选64支付宝客户id-208812345678
subscriptions.subscribe_titleString可选256订阅标题-订阅月会员
subscriptions.subscription_statusString可选64订阅状态，例如INCOMPLETE（未完成），ACTIVE（活跃），INCOMPLETE_EXPIRED（未完成已过期），CANCELED（已取消）等未完成：INCOMPLETE 活跃：ACTIVE 未完成已过期：INCOMPLETE_EXPIRED 已取消：CANCELEDACTIVE
subscriptions.current_period_startString可选32最近一个扣款周期开始时间-2026-02-20 14:10:00
subscriptions.current_period_endString可选32最近一个扣款周期结束时间-2026-03-20 14:10:00
subscriptions.cancel_at_period_endBoolean可选10true - 周期结束状态生效 false - 周期结束依旧生效-true
subscriptions.start_dateString可选32订阅开始日期-2026-03-22 14:00:00
subscriptions.canceled_dateString可选32订阅取消时间-2026-03-22 14:00:00
subscriptions.createdString可选32创建时间-2026-03-20 14:10:00
subscriptions.metadataString可选512订阅元数据，订阅创建时传入-{"key":"value"}
subscriptions.itemsSubscriptionQueryItem可选-订阅项目信息--
subscriptions.items.item_idString可选64订阅id-2026032012314
subscriptions.items.quantityNumber可选32订阅价格项目数量，单位个-1
subscriptions.items.createdString可选32创建时间-2026-03-20 14:10:00
subscriptions.items.priceNexusPayPrice可选-商品价格模型--
subscriptions.items.price.idString必选32价格 ID-20260324001001
subscriptions.items.price.activeBoolean必选10是否可用-true
subscriptions.items.price.typeString必选32价格类型订阅：recurring 单次支付：one_timerecurring
subscriptions.items.price.unit_amountString必选16单位金额，单位：分-1000
subscriptions.items.price.product_idString必选32商品 ID-202603240020000001001
subscriptions.items.price.productNexusPayProduct可选-价格归属的商品模型信息--
subscriptions.items.price.product.idString必选32商品 ID-20260324001001
subscriptions.items.price.product.nameString必选255商品名称-Gold 会员
subscriptions.items.price.product.descriptionString必选255商品描述-基础权益
subscriptions.items.price.product.activeBoolean必选10是否可用-true
subscriptions.items.price.product.default_price_idString可选32商品的默认价格 ID-20260324001001
subscriptions.items.price.product.default_priceNexusSimplePrice可选-默认价格信息--
subscriptions.items.price.product.default_price.idString必选32价格 ID-20260324001001
subscriptions.items.price.product.default_price.activeBoolean必选10是否可用-true
subscriptions.items.price.product.default_price.typeString必选32价格类型订阅：recurring 单次支付：one_timerecurring
subscriptions.items.price.product.default_price.unit_amountNumber必选32单位金额，单位：分-1000
subscriptions.items.price.product.default_price.recurringRecurring必选-订阅周期信息--
subscriptions.items.price.product.default_price.recurring.intervalString可选16订阅周期类型，目前支持DAY跟MONTH月：MONTH 天：DAYMONTH
subscriptions.items.price.product.default_price.recurring.interval_countNumber可选32订阅周期数量，目前周期单位只支持月或日-1
subscriptions.items.price.product.default_price.recurring.usage_typeString可选16计费模式固定计费：licensed 按量计费：meteredlicensed
subscriptions.items.price.product.default_price.recurring.trial_period_daysNumber可选32试用期天数-10
subscriptions.items.price.product.default_price.metadataString可选2000价格信息元数据-{"key":"value"}
subscriptions.items.price.product.default_price.custom_unit_amountCustomUnitAmount可选-自定义单价，当 unit_amount 为空时必选--
subscriptions.items.price.product.default_price.custom_unit_amount.enableBoolean必选10是否启用灵活定价，启用后可设置 preset、maximum、minimum 字段-true
subscriptions.items.price.product.default_price.custom_unit_amount.presetNumber可选32预设的自定义价格（单位：分），灵活定价开启后可设置-88888
subscriptions.items.price.product.default_price.custom_unit_amount.maximumNumber可选32可自定义的最大金额（单位：分），灵活定价开启后可设置-1000000000
subscriptions.items.price.product.default_price.custom_unit_amount.minimumNumber可选32可自定义的最小金额（单位：分），灵活定价开启后可设置-100
subscriptions.items.price.product.metadataString可选2000商品信息元数据，通过商品创建接口传入-{"key":"value"}
subscriptions.items.price.product.gmt_createString必选64创建时间-2026-03-24 18:00:00
subscriptions.items.price.recurringRecurring可选-仅当type=recurring时必选--
subscriptions.items.price.recurring.intervalString可选16订阅周期类型，目前支持DAY跟MONTH月：MONTH 天：DAYMONTH
subscriptions.items.price.recurring.interval_countNumber可选32订阅周期数量，目前周期单位只支持月或日-1
subscriptions.items.price.recurring.usage_typeString可选16计费模式固定计费：licensed 按量计费：meteredlicensed
subscriptions.items.price.recurring.trial_period_daysNumber可选32试用期天数-10
subscriptions.items.price.metadataString可选2000价格信息元数据，通过价格创建接口传入-{"key":"value"}
subscriptions.items.price.gmt_createString必选32创建时间-1774501132425
subscriptions.items.coupon_idString可选40优惠编码-FB28ET2Z
subscriptions.items.discount_amountString可选16折扣优惠金额,单位分-100
subscriptions.pending_itemsSubscriptionQueryPendingItem可选-待生效的订阅项--
subscriptions.pending_items.item_idString必选64订阅项id-2026032012314
subscriptions.pending_items.quantityString必选8订阅价格项目数量-10
subscriptions.pending_items.createdString必选32创建时间-2026-03-20 14:10:00
subscriptions.pending_items.statusString可选64订阅项状态待生效：PENDINGPENDING
subscriptions.pending_items.period_startString必选32订阅项周期开始时间-2026-03-20 14:10:00
subscriptions.pending_items.period_endString必选32订阅项周期截止时间-2026-03-20 14:10:00
subscriptions.pending_items.priceNexusPayPrice必选-商品价格模型--
subscriptions.pending_items.price.idString必选32价格 ID-20260324001001
subscriptions.pending_items.price.activeBoolean必选10是否可用-true
subscriptions.pending_items.price.typeString必选32价格类型订阅：recurring 单次支付：one_timerecurring
subscriptions.pending_items.price.unit_amountString必选16单位金额，单位：分-1000
subscriptions.pending_items.price.product_idString必选32商品 ID-202603240020000001001
subscriptions.pending_items.price.productNexusPayProduct可选-价格归属的商品模型信息--
subscriptions.pending_items.price.product.idString必选32商品 ID-20260324001001
subscriptions.pending_items.price.product.nameString必选255商品名称-Gold 会员
subscriptions.pending_items.price.product.descriptionString必选255商品描述-基础权益
subscriptions.pending_items.price.product.activeBoolean必选10是否可用-true
subscriptions.pending_items.price.product.default_price_idString可选32商品的默认价格 ID-20260324001001
subscriptions.pending_items.price.product.default_priceNexusSimplePrice可选-默认价格信息--
subscriptions.pending_items.price.product.default_price.idString必选32价格 ID-20260324001001
subscriptions.pending_items.price.product.default_price.activeBoolean必选10是否可用-true
subscriptions.pending_items.price.product.default_price.typeString必选32价格类型订阅：recurring 单次支付：one_timerecurring
subscriptions.pending_items.price.product.default_price.unit_amountNumber必选32单位金额，单位：分-1000
subscriptions.pending_items.price.product.default_price.recurringRecurring必选-订阅周期信息--
subscriptions.pending_items.price.product.default_price.recurring.intervalString可选16订阅周期类型，目前支持DAY跟MONTH月：MONTH 天：DAYMONTH
subscriptions.pending_items.price.product.default_price.recurring.interval_countNumber可选32订阅周期数量，目前周期单位只支持月或日-1
subscriptions.pending_items.price.product.default_price.recurring.usage_typeString可选16计费模式固定计费：licensed 按量计费：meteredlicensed
subscriptions.pending_items.price.product.default_price.recurring.trial_period_daysNumber可选32试用期天数-10
subscriptions.pending_items.price.product.default_price.metadataString可选2000价格信息元数据-{"key":"value"}
subscriptions.pending_items.price.product.default_price.custom_unit_amountCustomUnitAmount可选-自定义单价，当 unit_amount 为空时必选--
subscriptions.pending_items.price.product.default_price.custom_unit_amount.enableBoolean必选10是否启用灵活定价，启用后可设置 preset、maximum、minimum 字段-true
subscriptions.pending_items.price.product.default_price.custom_unit_amount.presetNumber可选32预设的自定义价格（单位：分），灵活定价开启后可设置-88888
subscriptions.pending_items.price.product.default_price.custom_unit_amount.maximumNumber可选32可自定义的最大金额（单位：分），灵活定价开启后可设置-1000000000
subscriptions.pending_items.price.product.default_price.custom_unit_amount.minimumNumber可选32可自定义的最小金额（单位：分），灵活定价开启后可设置-100
subscriptions.pending_items.price.product.metadataString可选2000商品信息元数据，通过商品创建接口传入-{"key":"value"}
subscriptions.pending_items.price.product.gmt_createString必选64创建时间-2026-03-24 18:00:00
subscriptions.pending_items.price.recurringRecurring可选-仅当type=recurring时必选--
subscriptions.pending_items.price.recurring.intervalString可选16订阅周期类型，目前支持DAY跟MONTH月：MONTH 天：DAYMONTH
subscriptions.pending_items.price.recurring.interval_countNumber可选32订阅周期数量，目前周期单位只支持月或日-1
subscriptions.pending_items.price.recurring.usage_typeString可选16计费模式固定计费：licensed 按量计费：meteredlicensed
subscriptions.pending_items.price.recurring.trial_period_daysNumber可选32试用期天数-10
subscriptions.pending_items.price.metadataString可选2000价格信息元数据，通过价格创建接口传入-{"key":"value"}
subscriptions.pending_items.price.gmt_createString必选32创建时间-1774501132425
subscriptions.trial_startString可选32试用期开始时间-2026-02-20 14:10:00
subscriptions.trial_endString可选32试用期结束时间-2026-02-27 23:59:59
subscriptions.deduct_typeString可选32有限枚举，托管扣款类型。1.SUBSCRIBE_DEDUCT：托管模式（支付宝自动扣款，默认）；2.MERCHANT_DEDUCT：非托管模式（商户自助扣款）SUBSCRIBE_DEDUCT：SUBSCRIBE_DEDUCT MERCHANT_DEDUCT：MERCHANT_DEDUCTSUBSCRIBE_DEDUCT

响应示例

{
    "alipay_trade_subscription_query_response":{
        "code":"10000",
        "msg":"Success",
        "subscriptions":[
            {
                "subscription_id":"20260320123156789",
                "customer_id":"208812345678",
                "subscribe_title":"订阅月会员",
                "subscription_status":"ACTIVE",
                "current_period_start":"2026-02-20 14:10:00",
                "current_period_end":"2026-03-20 14:10:00",
                "cancel_at_period_end":true,
                "start_date":"2026-03-22 14:00:00",
                "canceled_date":"2026-03-22 14:00:00",
                "created":"2026-03-20 14:10:00",
                "metadata":"{\"key\":\"value\"}",
                "items":[
                    {
                        "item_id":"2026032012314",
                        "quantity":1,
                        "created":"2026-03-20 14:10:00",
                        "price":{
                            "id":"20260324001001",
                            "active":true,
                            "type":"recurring",
                            "unit_amount":"1000",
                            "product_id":"202603240020000001001",
                            "product":{
                                "id":"20260324001001",
                                "name":"Gold 会员",
                                "description":"基础权益",
                                "active":true,
                                "default_price_id":"20260324001001",
                                "default_price":{
                                    "id":"20260324001001",
                                    "active":true,
                                    "type":"recurring",
                                    "unit_amount":1000,
                                    "recurring":{
                                        "interval":"MONTH",
                                        "interval_count":1,
                                        "usage_type":"licensed",
                                        "trial_period_days":10
                                    },
                                    "metadata":"{\"key\":\"value\"}",
                                    "custom_unit_amount":{
                                        "enable":true,
                                        "preset":88888,
                                        "maximum":1000000000,
                                        "minimum":100
                                    }
                                },
                                "metadata":"{\"key\":\"value\"}",
                                "gmt_create":"2026-03-24 18:00:00"
                            },
                            "recurring":{
                                "interval":"MONTH",
                                "interval_count":1,
                                "usage_type":"licensed",
                                "trial_period_days":10
                            },
                            "metadata":"{\"key\":\"value\"}",
                            "gmt_create":"1774501132425"
                        },
                        "coupon_id":"FB28ET2Z",
                        "discount_amount":"100"
                    }
                ],
                "pending_items":[
                    {
                        "item_id":"2026032012314",
                        "quantity":"10",
                        "created":"2026-03-20 14:10:00",
                        "status":"PENDING",
                        "period_start":"2026-03-20 14:10:00",
                        "period_end":"2026-03-20 14:10:00",
                        "price":{
                            "id":"20260324001001",
                            "active":true,
                            "type":"recurring",
                            "unit_amount":"1000",
                            "product_id":"202603240020000001001",
                            "product":{
                                "id":"20260324001001",
                                "name":"Gold 会员",
                                "description":"基础权益",
                                "active":true,
                                "default_price_id":"20260324001001",
                                "default_price":{
                                    "id":"20260324001001",
                                    "active":true,
                                    "type":"recurring",
                                    "unit_amount":1000,
                                    "recurring":{
                                        "interval":"MONTH",
                                        "interval_count":1,
                                        "usage_type":"licensed",
                                        "trial_period_days":10
                                    },
                                    "metadata":"{\"key\":\"value\"}",
                                    "custom_unit_amount":{
                                        "enable":true,
                                        "preset":88888,
                                        "maximum":1000000000,
                                        "minimum":100
                                    }
                                },
                                "metadata":"{\"key\":\"value\"}",
                                "gmt_create":"2026-03-24 18:00:00"
                            },
                            "recurring":{
                                "interval":"MONTH",
                                "interval_count":1,
                                "usage_type":"licensed",
                                "trial_period_days":10
                            },
                            "metadata":"{\"key\":\"value\"}",
                            "gmt_create":"1774501132425"
                        }
                    }
                ],
                "trial_start":"2026-02-20 14:10:00",
                "trial_end":"2026-02-27 23:59:59",
                "deduct_type":"SUBSCRIBE_DEDUCT"
            }
        ]
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{"alipay_trade_subscription_query_response":{"code":"20000","msg":"Service Currently Unavailable","sub_code":"isp.unknow-error","sub_msg":"系统繁忙"},"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"}

业务错误码

错误码错误描述解决方案
SYSTEM_ERROR系统繁忙服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
INVALID_PARAMETER参数有误请根据接口返回的参数非法的具体错误信息，修改参数后进行重试