lxbfYeaa/PayPal-PHP-Server-SDK

Template

Fork 0

forked from LiveCarta/PayPal-PHP-Server-SDK

Files

PayPalServerSDKs f774d5557c Automated commit message

2025-11-06 20:07:39 +00:00

40 KiB

Raw Blame History

Subscriptions

Use the /subscriptions resource to create, update, retrieve, and cancel subscriptions and their associated plans.

$subscriptionsController = $client->getSubscriptionsController();

Class Name

SubscriptionsController

Methods

Create Billing Plan

Creates a plan that defines pricing and billing cycle details for subscriptions.

function createBillingPlan(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`prefer`	`?string`	Header, Optional	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. Default: `'return=minimal'`
`paypalRequestId`	`?string`	Header, Optional	The server stores keys for 72 hours.
`body`	`?PlanRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type BillingPlan.

Example Usage

$collect = [
    'prefer' => 'return=minimal',
    'body' => PlanRequestBuilder::init(
        'product_id2',
        'name6',
        [
            SubscriptionBillingCycleBuilder::init(
                FrequencyBuilder::init(
                    IntervalUnit::DAY
                )
                    ->intervalCount(1)
                    ->build(),
                TenureType::REGULAR,
                8
            )
                ->totalCycles(1)
                ->build()
        ],
        PaymentPreferencesBuilder::init()
            ->autoBillOutstanding(true)
            ->setupFeeFailureAction(SetupFeeFailureAction::CANCEL)
            ->paymentFailureThreshold(0)
            ->build()
    )
        ->status(PlanRequestStatus::ACTIVE)
        ->quantitySupported(false)
        ->build()
];

$apiResponse = $subscriptionsController->createBillingPlan($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

List Billing Plans

Lists billing plans.

function listBillingPlans(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`prefer`	`?string`	Header, Optional	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, name, description and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource. Default: `'return=minimal'`
`productId`	`?string`	Query, Optional	Filters the response by a Product ID. Constraints: Minimum Length: `6`, Maximum Length: `50`
`pageSize`	`?int`	Query, Optional	The number of items to return in the response. Default: `10` Constraints: `>= 1`, `<= 20`
`page`	`?int`	Query, Optional	A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items. Default: `1` Constraints: `>= 1`, `<= 100000`
`totalRequired`	`?bool`	Query, Optional	Indicates whether to show the total count in the response. Default: `false`

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type PlanCollection.

Example Usage

$collect = [
    'prefer' => 'return=minimal',
    'pageSize' => 10,
    'page' => 1,
    'totalRequired' => false
];

$apiResponse = $subscriptionsController->listBillingPlans($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Get Billing Plan

Shows details for a plan, by ID.

function getBillingPlan(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the plan.

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type BillingPlan.

Example Usage

$id = 'id0';

$apiResponse = $subscriptionsController->getBillingPlan($id);

Errors

HTTP Status Code	Error Description	Exception Class
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Patch Billing Plan

Updates a plan with the CREATED or ACTIVE status. For an INACTIVE plan, you can make only status updates. You can patch these attributes and objects: Attribute or object Operations description replace payment_preferences.auto_bill_outstanding replace taxes.percentage replace payment_preferences.payment_failure_threshold replace payment_preferences.setup_fee replace payment_preferences.setup_fee_failure_action replace name replace

function patchBillingPlan(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the plan.
`body`	`?(Patch[])`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0',
    'body' => [
        PatchBuilder::init(
            PatchOp::ADD
        )->build()
    ]
];

$apiResponse = $subscriptionsController->patchBillingPlan($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Activate Billing Plan

Activates a plan, by ID.

function activateBillingPlan(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the plan.

Response Type

This method returns an ApiResponse instance.

Example Usage

$id = 'id0';

$apiResponse = $subscriptionsController->activateBillingPlan($id);

Errors

HTTP Status Code	Error Description	Exception Class
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Deactivate Billing Plan

Deactivates a plan, by ID.

function deactivateBillingPlan(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the plan.

Response Type

This method returns an ApiResponse instance.

Example Usage

$id = 'id0';

$apiResponse = $subscriptionsController->deactivateBillingPlan($id);

Errors

HTTP Status Code	Error Description	Exception Class
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Update Billing Plan Pricing Schemes

Updates pricing for a plan. For example, you can update a regular billing cycle from $5 per month to $7 per month.

function updateBillingPlanPricingSchemes(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID for the plan.
`body`	`?UpdatePricingSchemesRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0',
    'body' => UpdatePricingSchemesRequestBuilder::init(
        [
            UpdatePricingSchemeBuilder::init(
                34,
                SubscriptionPricingSchemeBuilder::init()->build()
            )->build()
        ]
    )->build()
];

$apiResponse = $subscriptionsController->updateBillingPlanPricingSchemes($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Create Subscription

Creates a subscription.

function createSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`prefer`	`?string`	Header, Optional	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. Default: `'return=minimal'`
`paypalRequestId`	`?string`	Header, Optional	The server stores keys for 72 hours.
`paypalClientMetadataId`	`?string`	Header, Optional	The PayPal Client Metadata Id(CMID) is used to provide device-specific information to PayPal's risk engine. This is crucial for transactions that require device-specific risk assessments. Merchants typically use the Paypal SDK that automatically submits the CMID or they use tools like Fraudnet JS for web or Magnes JS for mobile to generate the CMID on the frontend and then pass it to the API as part of the request headers. Constraints: Minimum Length: `1`, Maximum Length: `36`
`body`	`?CreateSubscriptionRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type Subscription.

Example Usage

$collect = [
    'prefer' => 'return=minimal',
    'body' => CreateSubscriptionRequestBuilder::init(
        'plan_id8'
    )
        ->autoRenewal(false)
        ->build()
];

$apiResponse = $subscriptionsController->createSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

List Subscriptions

List all subscriptions for merchant account.

function listSubscriptions(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`planIds`	`?string`	Query, Optional	Filters the response by list of plan IDs. Filter supports upto 70 plan IDs. URLs should not exceed a length of 2000 characters.
`statuses`	`?string`	Query, Optional	Filters the response by list of subscription statuses. Constraints: Minimum Length: `1`, Maximum Length: `70`, Pattern: `^[A-Z_,]+$`
`createdAfter`	`?string`	Query, Optional	Filters the response by subscription creation start time for a range of subscriptions. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`
`createdBefore`	`?string`	Query, Optional	Filters the response by subscription creation end time for a range of subscriptions. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`
`statusUpdatedBefore`	`?string`	Query, Optional	Filters the response by status update start time for a range of subscriptions. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`
`statusUpdatedAfter`	`?string`	Query, Optional	Filters the response by status update end time for a range of subscriptions. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`
`filter`	`?string`	Query, Optional	Filter the response using complex expressions that could use comparison operators like ge, gt, le, lt and logical operators such as 'and' and 'or'. Constraints: Minimum Length: `0`, Maximum Length: `100`
`pageSize`	`?int`	Query, Optional	The number of items to return in the response. Default: `10` Constraints: `>= 1`, `<= 20`
`page`	`?int`	Query, Optional	A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items. Default: `1` Constraints: `>= 1`, `<= 10000000`
`customerIds`	`?(string[])`	Query, Optional	Filters the response by comma separated vault customer IDs (FSS subscriptions only). Constraints: Minimum Items: `1`, Maximum Items: `10`, Minimum Length: `1`, Maximum Length: `22`, Pattern: `^[0-9a-zA-Z_-]+$`

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type SubscriptionCollection.

Example Usage

$collect = [
    'pageSize' => 10,
    'page' => 1
];

$apiResponse = $subscriptionsController->listSubscriptions($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Get Subscription

Shows details for a subscription, by ID.

function getSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`fields`	`?string`	Query, Optional	List of fields that are to be returned in the response. Possible value for fields are last_failed_payment and plan. Constraints: Minimum Length: `1`, Maximum Length: `100`

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type Subscription.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->getSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Patch Subscription

Updates a subscription which could be in ACTIVE or SUSPENDED status. You can override plan level default attributes by providing customised values for plan path in the patch request. You cannot update attributes that have already completed (Example - trial cycles can’t be updated if completed). Once overridden, changes to plan resource will not impact subscription. Any price update will not impact billing cycles within next 10 days (Applicable only for subscriptions funded by PayPal account). Following are the fields eligible for patch. Attribute or object Operations billing_info.outstanding_balance replace custom_id add,replace plan.billing_cycles[@sequence==n]. pricing_scheme.fixed_price add,replace plan.billing_cycles[@sequence==n]. pricing_scheme.tiers replace plan.billing_cycles[@sequence==n]. total_cycles replace plan.payment_preferences. auto_bill_outstanding replace plan.payment_preferences. payment_failure_threshold replace plan.taxes.inclusive add,replace plan.taxes.percentage add,replace shipping_amount add,replace start_time replace subscriber.shipping_address add,replace subscriber.payment_source (for subscriptions funded by card payments) replace

function patchSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID for the subscription.
`body`	`?(Patch[])`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0',
    'body' => [
        PatchBuilder::init(
            PatchOp::ADD
        )->build()
    ]
];

$apiResponse = $subscriptionsController->patchSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Revise Subscription

Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount, shipping_address values for the subscription. This type of update requires the buyer's consent.

function reviseSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`body`	`?ModifySubscriptionRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type ModifySubscriptionResponse.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->reviseSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Suspend Subscription

Suspends the subscription.

function suspendSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`body`	`?SuspendSubscription`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->suspendSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Cancel Subscription

Cancels the subscription.

function cancelSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`body`	`?CancelSubscriptionRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->cancelSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Activate Subscription

Activates the subscription.

function activateSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`body`	`?ActivateSubscriptionRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->activateSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

Capture Subscription

Captures an authorized payment from the subscriber on the subscription.

function captureSubscription(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`paypalRequestId`	`?string`	Header, Optional	The server stores keys for 72 hours.
`body`	`?CaptureSubscriptionRequest`	Body, Optional	-

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type ?SubscriptionTransactionDetails.

Example Usage

$collect = [
    'id' => 'id0'
];

$apiResponse = $subscriptionsController->captureSubscription($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
422	The requested action could not be performed, semantically incorrect, or failed business validation.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

List Subscription Transactions

Lists transactions for a subscription.

function listSubscriptionTransactions(array $options): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the subscription.
`startTime`	`string`	Query, Required	The start time of the range of transactions to list. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`
`endTime`	`string`	Query, Required	The end time of the range of transactions to list. Constraints: Minimum Length: `20`, Maximum Length: `64`, Pattern: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$`

Response Type

This method returns an ApiResponse instance. The getResult() method on this instance returns the response data which is of type TransactionsList.

Example Usage

$collect = [
    'id' => 'id0',
    'startTime' => 'start_time6',
    'endTime' => 'end_time2'
];

$apiResponse = $subscriptionsController->listSubscriptionTransactions($collect);

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	`SubscriptionErrorException`
401	Authentication failed due to missing authorization header, or invalid authentication credentials.	`SubscriptionErrorException`
403	Authorization failed due to insufficient permissions.	`SubscriptionErrorException`
404	The specified resource does not exist.	`SubscriptionErrorException`
500	An internal server error has occurred.	`SubscriptionErrorException`
Default	The error response.	`SubscriptionErrorException`

40 KiB Raw Blame History Unescape Escape

Subscriptions

Class Name

Methods

Create Billing Plan

Parameters

Response Type

Example Usage

Errors

List Billing Plans

Parameters

Response Type

Example Usage

Errors

Get Billing Plan

Parameters

Response Type

Example Usage

Errors

Patch Billing Plan

Parameters

Response Type

Example Usage

Errors

Activate Billing Plan

Parameters

Response Type

Example Usage

Errors

Deactivate Billing Plan

Parameters

Response Type

Example Usage

Errors

Update Billing Plan Pricing Schemes

Parameters

Response Type

Example Usage

Errors

Create Subscription

Parameters

Response Type

Example Usage

Errors

List Subscriptions

Parameters

Response Type

Example Usage

Errors

Get Subscription

Parameters

Response Type

Example Usage

Errors

Patch Subscription

Parameters

Response Type

Example Usage

Errors

Revise Subscription

Parameters

Response Type

Example Usage

Errors

Suspend Subscription

Parameters

Response Type

Example Usage

Errors

Cancel Subscription

Parameters

Response Type

Example Usage

Errors

Activate Subscription

Parameters

Response Type

Example Usage

Errors

Capture Subscription

40 KiB

Raw Blame History