Recurly v3 API

Client extends BaseClient

ALLOWED_OPTIONS = ['params', 'headers']
API_HOSTS = ['us' => 'https://v3.recurly.com', 'eu' => 'https://v3.eu.recurly.com']
$baseUrl : mixed
$http : mixed
$_api_key : mixed
$_logger : mixed
__construct() : mixed: Constructor
applyCreditBalance() : Invoice: Apply available credit to a pending or past due charge invoice
cancelpurchase() : InvoiceCollection: Cancel Purchase
cancelSubscription() : Subscription: Cancel a subscription
collectInvoice() : Invoice: Collect a pending or past due, automatic invoice
convertTrial() : Subscription: Convert trial subscription
createAccount() : Account: Create an account
createAccountExternalAccount() : ExternalAccount: Create an external account
createAuthorizePurchase() : InvoiceCollection: Authorize a purchase
createBillingInfo() : BillingInfo: Add new billing information on an account
createCapturePurchase() : InvoiceCollection: Capture a purchase
createCoupon() : Coupon: Create a new coupon
createCouponRedemption() : CouponRedemption: Generate an active coupon redemption on an account or subscription
createExternalProduct() : ExternalProduct: Create an external product
createExternalProductExternalProductReference() : ExternalProductReferenceMini: Create an external product reference on an external product
createExternalSubscription() : ExternalSubscription: Create an external subscription
createGeneralLedgerAccount() : GeneralLedgerAccount: Create a new general ledger account
createGiftCard() : GiftCard: Create gift card
createInvoice() : InvoiceCollection: Create an invoice for pending line items
createItem() : Item: Create a new item
createLineItem() : LineItem: Create a new line item for the account
createMeasuredUnit() : MeasuredUnit: Create a new measured unit
createPendingPurchase() : InvoiceCollection: Create a pending purchase
createPlan() : Plan: Create a plan
createPlanAddOn() : AddOn: Create an add-on
createPurchase() : InvoiceCollection: Create a new purchase
createShippingAddress() : ShippingAddress: Create a new shipping address for the account
createShippingMethod() : ShippingMethod: Create a new shipping method
createSubscription() : Subscription: Create a new subscription
createSubscriptionChange() : SubscriptionChange: Create a new subscription change
createUsage() : Usage: Log a usage record on this subscription add-on
deactivateAccount() : Account: Deactivate an account
deactivateCoupon() : Coupon: Expire a coupon
deactivateExternalProductExternalProductReference() : ExternalProductReferenceMini: Deactivate an external product reference
deactivateExternalProducts() : ExternalProduct: Deactivate an external product
deactivateItem() : Item: Deactivate an item
deactivateShippingMethod() : ShippingMethod: Deactivate a shipping method
deactivateUniqueCouponCode() : UniqueCouponCode: Deactivate a unique coupon code
deleteAccountExternalAccount() : ExternalAccount: Delete an external account for an account
generateUniqueCouponCodes() : UniqueCouponCodeParams: Generate unique coupon codes
getABillingInfo() : BillingInfo: Fetch a billing info
getAccount() : Account: Fetch an account
getAccountAcquisition() : AccountAcquisition: Fetch an account's acquisition data
getAccountBalance() : AccountBalance: Fetch an account's balance and past due status
getAccountExternalAccount() : ExternalAccount: Get an external account for an account
getAccountNote() : AccountNote: Fetch an account note
getAddOn() : AddOn: Fetch an add-on
getBillingInfo() : BillingInfo: Fetch an account's billing information
getBusinessEntity() : BusinessEntity: Fetch a business entity
getCoupon() : Coupon: Fetch a coupon
getCreditPayment() : CreditPayment: Fetch a credit payment
getCustomFieldDefinition() : CustomFieldDefinition: Fetch an custom field definition
getDunningCampaign() : DunningCampaign: Fetch a dunning campaign
getExportDates() : ExportDates: List the dates that have an available export to download.
getExportFiles() : ExportFiles: List of the export files that are available to download.
getExternalProduct() : ExternalProduct: Fetch an external product
getExternalProductExternalProductReference() : ExternalProductReferenceMini: Fetch an external product reference
getExternalSubscription() : ExternalSubscription: Fetch an external subscription
getExternalSubscriptionExternalPaymentPhase() : ExternalPaymentPhase: Fetch an external payment phase
getGeneralLedgerAccount() : GeneralLedgerAccount: Fetch a general ledger account
getGiftCard() : GiftCard: Fetch a gift card
getInvoice() : Invoice: Fetch an invoice
getInvoicePdf() : BinaryFile: Fetch an invoice as a PDF
getInvoiceTemplate() : InvoiceTemplate: Fetch an invoice template
getItem() : Item: Fetch an item
getLineItem() : LineItem: Fetch a line item
getMeasuredUnit() : MeasuredUnit: Fetch a measured unit
getPerformanceObligation() : PerformanceObligation: Get a single Performance Obligation.
getPerformanceObligations() : Pager: Get a site's Performance Obligations
getPlan() : Plan: Fetch a plan
getPlanAddOn() : AddOn: Fetch a plan's add-on
getPreviewRenewal() : InvoiceCollection: Fetch a preview of a subscription's renewal invoice(s)
getShippingAddress() : ShippingAddress: Fetch an account's shipping address
getShippingMethod() : ShippingMethod: Fetch a shipping method
getSite() : Site: Fetch a site
getSubscription() : Subscription: Fetch a subscription
getSubscriptionChange() : SubscriptionChange: Fetch a subscription's pending change
getTransaction() : Transaction: Fetch a transaction
getUniqueCouponCode() : UniqueCouponCode: Fetch a unique coupon code
getUsage() : Usage: Get a usage record
listAccountAcquisition() : Pager: List a site's account acquisition data
listAccountCouponRedemptions() : Pager: List the coupon redemptions for an account
listAccountCreditPayments() : Pager: List an account's credit payments
listAccountExternalAccount() : Pager: List external accounts for an account
listAccountExternalInvoices() : Pager: List the external invoices on an account
listAccountExternalSubscriptions() : Pager: List an account's external subscriptions
listAccountInvoices() : Pager: List an account's invoices
listAccountLineItems() : Pager: List an account's line items
listAccountNotes() : Pager: List an account's notes
listAccounts() : Pager: List a site's accounts
listAccountSubscriptions() : Pager: List an account's subscriptions
listAccountTransactions() : Pager: List an account's transactions
listActiveCouponRedemptions() : Pager: List the coupon redemptions that are active on an account
listAddOns() : Pager: List a site's add-ons
listBillingInfos() : Pager: Get the list of billing information associated with an account
listBusinessEntities() : Pager: List business entities
listBusinessEntityInvoices() : Pager: List a business entity's invoices
listChildAccounts() : Pager: List an account's child accounts
listCoupons() : Pager: List a site's coupons
listCreditPayments() : Pager: List a site's credit payments
listCustomFieldDefinitions() : Pager: List a site's custom field definitions
listDunningCampaigns() : Pager: List the dunning campaigns for a site
listEntitlements() : Pager: List entitlements granted to an account
listExternalInvoices() : Pager: List the external invoices on a site
listExternalProductExternalProductReferences() : Pager: List the external product references for an external product
listExternalProducts() : Pager: List a site's external products
listExternalSubscriptionExternalInvoices() : Pager: List the external invoices on an external subscription
listExternalSubscriptionExternalPaymentPhases() : Pager: List the external payment phases on an external subscription
listExternalSubscriptions() : Pager: List the external subscriptions on a site
listGeneralLedgerAccounts() : Pager: List a site's general ledger accounts
listGiftCards() : Pager: List gift cards
listInvoiceCouponRedemptions() : Pager: List the coupon redemptions applied to an invoice
listInvoiceLineItems() : Pager: List an invoice's line items
listInvoices() : Pager: List a site's invoices
listInvoiceTemplateAccounts() : Pager: List an invoice template's associated accounts
listInvoiceTemplates() : Pager: Show the invoice templates for a site
listItems() : Pager: List a site's items
listLineItems() : Pager: List a site's line items
listMeasuredUnit() : Pager: List a site's measured units
listPlanAddOns() : Pager: List a plan's add-ons
listPlans() : Pager: List a site's plans
listRelatedInvoices() : Pager: List an invoice's related credit or charge invoices
listShippingAddresses() : Pager: Fetch a list of an account's shipping addresses
listShippingMethods() : Pager: List a site's shipping methods
listSites() : Pager: List sites
listSubscriptionCouponRedemptions() : Pager: List the coupon redemptions for a subscription
listSubscriptionInvoices() : Pager: List a subscription's invoices
listSubscriptionLineItems() : Pager: List a subscription's line items
listSubscriptions() : Pager: List a site's subscriptions
listTransactions() : Pager: List a site's transactions
listUniqueCouponCodes() : Pager: List unique coupon codes associated with a bulk coupon
listUsage() : Pager: List a subscription add-on's usage records
markInvoiceFailed() : Invoice: Mark an open invoice as failed
markInvoiceSuccessful() : Invoice: Mark an open invoice as successful
nextPage() : Page: Used by the \Recurly\Pager to make requests to the API.
pagerCount() : Response: Used by the \Recurly\Pager to obtain total counts from the API.
pauseSubscription() : Subscription: Pause subscription
previewGiftCard() : GiftCard: Preview gift card
previewInvoice() : InvoiceCollection: Preview new invoice for pending line items
previewPurchase() : InvoiceCollection: Preview a new purchase
previewSubscriptionChange() : SubscriptionChange: Preview a new subscription change
putDunningCampaignBulkUpdate() : DunningCampaignsBulkUpdateResponse: Assign a dunning campaign to multiple plans
putExternalSubscription() : ExternalSubscription: Update an external subscription
reactivateAccount() : Account: Reactivate an inactive account
reactivateItem() : Item: Reactivate an inactive item
reactivateSubscription() : Subscription: Reactivate a canceled subscription
reactivateUniqueCouponCode() : UniqueCouponCode: Restore a unique coupon code
recordExternalTransaction() : Transaction: Record an external payment for a manual invoices.
redeemGiftCard() : GiftCard: Redeem gift card
refundInvoice() : Invoice: Refund an invoice
removeABillingInfo() : EmptyResource: Remove an account's billing information
removeAccountAcquisition() : EmptyResource: Remove an account's acquisition data
removeBillingInfo() : EmptyResource: Remove an account's billing information
removeCouponRedemption() : CouponRedemption: Delete the active coupon redemption from an account
removeLineItem() : EmptyResource: Delete an uninvoiced line item
removeMeasuredUnit() : MeasuredUnit: Remove a measured unit
removePlan() : Plan: Remove a plan
removePlanAddOn() : AddOn: Remove an add-on
removeShippingAddress() : EmptyResource: Remove an account's shipping address
removeSubscriptionChange() : EmptyResource: Delete the pending subscription change
removeUsage() : EmptyResource: Delete a usage record.
reopenInvoice() : Invoice: Reopen a closed, manual invoice
restoreCoupon() : Coupon: Restore an inactive coupon
resumeSubscription() : Subscription: Resume subscription
showExternalInvoice() : ExternalInvoice: Fetch an external invoice
terminateSubscription() : Subscription: Terminate a subscription
updateABillingInfo() : BillingInfo: Update an account's billing information
updateAccount() : Account: Update an account
updateAccountAcquisition() : AccountAcquisition: Update an account's acquisition data
updateAccountExternalAccount() : ExternalAccount: Update an external account
updateBillingInfo() : BillingInfo: Set an account's billing information
updateCoupon() : Coupon: Update an active coupon
updateExternalProduct() : ExternalProduct: Update an external product
updateGeneralLedgerAccount() : GeneralLedgerAccount: Update a general ledger account
updateInvoice() : Invoice: Update an invoice
updateItem() : Item: Update an active item
updateMeasuredUnit() : MeasuredUnit: Update a measured unit
updatePlan() : Plan: Update a plan
updatePlanAddOn() : AddOn: Update an add-on
updateShippingAddress() : ShippingAddress: Update an account's shipping address
updateShippingMethod() : ShippingMethod: Update an active Shipping Method
updateSubscription() : Subscription: Update a subscription
updateUsage() : Usage: Update a usage record
verifyBillingInfo() : Transaction: Verify an account's credit card billing information
verifyBillingInfoCvv() : Transaction: Verify an account's credit card billing cvv
voidInvoice() : Invoice: Void a credit invoice.
apiVersion() : string: The Recurly openapi spec version that this client library was generated for.
encodeApiKey() : string: Base64 encodes the API key
getUserAgent() : string: Generates User-Agent for API requests
interpolatePath() : string: Replaces placeholder values with supplied values
makeRequest() : RecurlyResource: Performs API requests and processes the response into a Recurly Resource
titleize() : string: Capitalizes all the words in the $input.
_buildPath() : string: Build the URL that the API request will be sent to
_coreHeaders() : array<string|int, mixed>: Generates core headers to be sent with the HTTP request
_formatDateTimes() : array<string|int, mixed>: Converts any DateTime values in $arr to ISO8601 strings
_getResponse() : Response: Performs the HTTP request to the Recurly API
_mapArrayParams() : array<string|int, mixed>: Maps parameters with array values into csv strings. The API expects these values to be csv strings, but an array is a nicer interface for developers.
_mapBooleanParams() : array<string|int, mixed>: Maps parameters with boolean value into strings. The API expects these values to be booleans, but http_build_query transforms actual php booleans into integers. So the workaround is to provide them as strings instead.
_validateOptions() : void: Checks that $options keys are valid
_validatePathParameters() : void: Checks that path parameters are valid

ALLOWED_OPTIONS


    private
    mixed
    ALLOWED_OPTIONS
    = ['params', 'headers']

API_HOSTS


    private
    mixed
    API_HOSTS
    = ['us' => 'https://v3.recurly.com', 'eu' => 'https://v3.eu.recurly.com']

$baseUrl


    protected
        mixed
    $baseUrl
     = RecurlyBaseClient::API_HOSTS['us']

$http


    protected
        mixed
    $http

$_api_key


    private
        mixed
    $_api_key

$_logger


    private
        mixed
    $_logger

__construct()

Constructor


    public
                __construct(string $api_key[, LoggerInterface $logger = null ][, string $options = [] ]) : mixed

Parameters

$api_key : string

The API key to use when making requests

$logger : LoggerInterface = null

$options : string = []

initialize options

In addition to the options managed by BaseClient, it accepts the following options:

"region" to define the Data Center connection - defaults to "us";

Return values

mixed —

applyCreditBalance()

Apply available credit to a pending or past due charge invoice


    public
                applyCreditBalance(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

cancelpurchase()

Cancel Purchase


    public
                cancelpurchase(string $transaction_id[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$transaction_id : string: Transaction ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the cancelled invoice

cancelSubscription()

Cancel a subscription


    public
                cancelSubscription(string $subscription_id[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$body : array<string|int, mixed> = []: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A canceled or failed subscription.

collectInvoice()

Collect a pending or past due, automatic invoice


    public
                collectInvoice(string $invoice_id[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$body : array<string|int, mixed> = []: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

convertTrial()

Convert trial subscription


    public
                convertTrial(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

createAccount()

Create an account


    public
                createAccount(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Account

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Account —

An account.

createAccountExternalAccount()

Create an external account


    public
                createAccountExternalAccount(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalAccount

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalAccount —

A representation of the created external_account.

createAuthorizePurchase()

Authorize a purchase


    public
                createAuthorizePurchase(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the authorize invoice

createBillingInfo()

Add new billing information on an account


    public
                createBillingInfo(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : BillingInfo

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BillingInfo —

Updated billing information.

createCapturePurchase()

Capture a purchase


    public
                createCapturePurchase(string $transaction_id[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$transaction_id : string: Transaction ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the captured invoice

createCoupon()

Create a new coupon


    public
                createCoupon(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Coupon

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Coupon —

A new coupon.

createCouponRedemption()

Generate an active coupon redemption on an account or subscription


    public
                createCouponRedemption(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : CouponRedemption

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

CouponRedemption —

Returns the new coupon redemption.

createExternalProduct()

Create an external product


    public
                createExternalProduct(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalProduct

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProduct —

Returns the external product

createExternalProductExternalProductReference()

Create an external product reference on an external product


    public
                createExternalProductExternalProductReference(string $external_product_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalProductReferenceMini

Parameters

$external_product_id : string: External product id
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProductReferenceMini —

Details for the external product reference.

createExternalSubscription()

Create an external subscription


    public
                createExternalSubscription(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalSubscription

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalSubscription —

Returns the external subscription

createGeneralLedgerAccount()

Create a new general ledger account


    public
                createGeneralLedgerAccount(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : GeneralLedgerAccount

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GeneralLedgerAccount —

A new general ledger account.

createGiftCard()

Create gift card


    public
                createGiftCard(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : GiftCard

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GiftCard —

Returns the gift card

createInvoice()

Create an invoice for pending line items


    public
                createInvoice(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the new invoices.

createItem()

Create a new item


    public
                createItem(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Item

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Item —

A new item.

createLineItem()

Create a new line item for the account


    public
                createLineItem(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : LineItem

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

LineItem —

Returns the new line item.

createMeasuredUnit()

Create a new measured unit


    public
                createMeasuredUnit(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : MeasuredUnit

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

MeasuredUnit —

A new measured unit.

createPendingPurchase()

Create a pending purchase


    public
                createPendingPurchase(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the pending invoice

createPlan()

Create a plan


    public
                createPlan(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Plan

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Plan —

A plan.

createPlanAddOn()

Create an add-on


    public
                createPlanAddOn(string $plan_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : AddOn

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AddOn —

An add-on.

createPurchase()

Create a new purchase


    public
                createPurchase(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the new invoices

createShippingAddress()

Create a new shipping address for the account


    public
                createShippingAddress(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ShippingAddress

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingAddress —

Returns the new shipping address.

createShippingMethod()

Create a new shipping method


    public
                createShippingMethod(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ShippingMethod

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingMethod —

A new shipping method.

createSubscription()

Create a new subscription


    public
                createSubscription(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

createSubscriptionChange()

Create a new subscription change


    public
                createSubscriptionChange(string $subscription_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : SubscriptionChange

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

SubscriptionChange —

A subscription change.

createUsage()

Log a usage record on this subscription add-on


    public
                createUsage(string $subscription_id, string $add_on_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Usage

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$add_on_id : string: Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Usage —

The created usage record.

deactivateAccount()

Deactivate an account


    public
                deactivateAccount(string $account_id[, array<string|int, mixed> $options = [] ]) : Account

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Account —

An account.

deactivateCoupon()

Expire a coupon


    public
                deactivateCoupon(string $coupon_id[, array<string|int, mixed> $options = [] ]) : Coupon

Parameters

$coupon_id : string: Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Coupon —

The expired Coupon

deactivateExternalProductExternalProductReference()

Deactivate an external product reference


    public
                deactivateExternalProductExternalProductReference(string $external_product_id, string $external_product_reference_id[, array<string|int, mixed> $options = [] ]) : ExternalProductReferenceMini

Parameters

$external_product_id : string: External product id
$external_product_reference_id : string: External product reference ID, e.g. d39iun2fw1v4.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProductReferenceMini —

Details for an external product reference.

deactivateExternalProducts()

Deactivate an external product


    public
                deactivateExternalProducts(string $external_product_id[, array<string|int, mixed> $options = [] ]) : ExternalProduct

Parameters

$external_product_id : string: External product id
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProduct —

Deactivated external product.

deactivateItem()

Deactivate an item


    public
                deactivateItem(string $item_id[, array<string|int, mixed> $options = [] ]) : Item

Parameters

$item_id : string: Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Item —

An item.

deactivateShippingMethod()

Deactivate a shipping method


    public
                deactivateShippingMethod(string $shipping_method_id[, array<string|int, mixed> $options = [] ]) : ShippingMethod

Parameters

$shipping_method_id : string: Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingMethod —

A shipping method.

deactivateUniqueCouponCode()

Deactivate a unique coupon code


    public
                deactivateUniqueCouponCode(string $unique_coupon_code_id[, array<string|int, mixed> $options = [] ]) : UniqueCouponCode

Parameters

$unique_coupon_code_id : string: Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

UniqueCouponCode —

A unique coupon code.

deleteAccountExternalAccount()

Delete an external account for an account


    public
                deleteAccountExternalAccount(string $account_id, string $external_account_id[, array<string|int, mixed> $options = [] ]) : ExternalAccount

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$external_account_id : string: External account ID, e.g. s28zov4fw0cb.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalAccount —

Successful Delete

generateUniqueCouponCodes()

Generate unique coupon codes


    public
                generateUniqueCouponCodes(string $coupon_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : UniqueCouponCodeParams

Parameters

$coupon_id : string: Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

UniqueCouponCodeParams —

A set of parameters that can be passed to the list_unique_coupon_codes endpoint to obtain only the newly generated UniqueCouponCodes.

getABillingInfo()

Fetch a billing info


    public
                getABillingInfo(string $account_id, string $billing_info_id[, array<string|int, mixed> $options = [] ]) : BillingInfo

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$billing_info_id : string: Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BillingInfo —

A billing info.

getAccount()

Fetch an account


    public
                getAccount(string $account_id[, array<string|int, mixed> $options = [] ]) : Account

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Account —

An account.

getAccountAcquisition()

Fetch an account's acquisition data


    public
                getAccountAcquisition(string $account_id[, array<string|int, mixed> $options = [] ]) : AccountAcquisition

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AccountAcquisition —

An account's acquisition data.

getAccountBalance()

Fetch an account's balance and past due status


    public
                getAccountBalance(string $account_id[, array<string|int, mixed> $options = [] ]) : AccountBalance

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AccountBalance —

An account's balance.

getAccountExternalAccount()

Get an external account for an account


    public
                getAccountExternalAccount(string $account_id, string $external_account_id[, array<string|int, mixed> $options = [] ]) : ExternalAccount

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$external_account_id : string: External account ID, e.g. s28zov4fw0cb.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalAccount —

A external account on an account.

getAccountNote()

Fetch an account note


    public
                getAccountNote(string $account_id, string $account_note_id[, array<string|int, mixed> $options = [] ]) : AccountNote

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$account_note_id : string: Account Note ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AccountNote —

An account note.

getAddOn()

Fetch an add-on


    public
                getAddOn(string $add_on_id[, array<string|int, mixed> $options = [] ]) : AddOn

Parameters

$add_on_id : string: Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AddOn —

An add-on.

getBillingInfo()

Fetch an account's billing information


    public
                getBillingInfo(string $account_id[, array<string|int, mixed> $options = [] ]) : BillingInfo

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BillingInfo —

An account's billing information.

getBusinessEntity()

Fetch a business entity


    public
                getBusinessEntity(string $business_entity_id[, array<string|int, mixed> $options = [] ]) : BusinessEntity

Parameters

$business_entity_id : string: Business Entity ID. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-entity1.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BusinessEntity —

Business entity details

getCoupon()

Fetch a coupon


    public
                getCoupon(string $coupon_id[, array<string|int, mixed> $options = [] ]) : Coupon

Parameters

$coupon_id : string: Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Coupon —

A coupon.

getCreditPayment()

Fetch a credit payment


    public
                getCreditPayment(string $credit_payment_id[, array<string|int, mixed> $options = [] ]) : CreditPayment

Parameters

$credit_payment_id : string: Credit Payment ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

CreditPayment —

A credit payment.

getCustomFieldDefinition()

Fetch an custom field definition


    public
                getCustomFieldDefinition(string $custom_field_definition_id[, array<string|int, mixed> $options = [] ]) : CustomFieldDefinition

Parameters

$custom_field_definition_id : string: Custom Field Definition ID
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

CustomFieldDefinition —

A custom field definition.

getDunningCampaign()

Fetch a dunning campaign


    public
                getDunningCampaign(string $dunning_campaign_id[, array<string|int, mixed> $options = [] ]) : DunningCampaign

Parameters

$dunning_campaign_id : string: Dunning Campaign ID, e.g. e28zov4fw0v2.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

DunningCampaign —

Settings for a dunning campaign.

getExportDates()

List the dates that have an available export to download.


    public
                getExportDates([array<string|int, mixed> $options = [] ]) : ExportDates

Parameters

$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExportDates —

Returns a list of dates.

getExportFiles()

List of the export files that are available to download.


    public
                getExportFiles(string $export_date[, array<string|int, mixed> $options = [] ]) : ExportFiles

Parameters

$export_date : string: Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExportFiles —

Returns a list of export files to download.

getExternalProduct()

Fetch an external product


    public
                getExternalProduct(string $external_product_id[, array<string|int, mixed> $options = [] ]) : ExternalProduct

Parameters

$external_product_id : string: External product id
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProduct —

Settings for an external product.

getExternalProductExternalProductReference()

Fetch an external product reference


    public
                getExternalProductExternalProductReference(string $external_product_id, string $external_product_reference_id[, array<string|int, mixed> $options = [] ]) : ExternalProductReferenceMini

Parameters

$external_product_id : string: External product id
$external_product_reference_id : string: External product reference ID, e.g. d39iun2fw1v4.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProductReferenceMini —

Details for an external product reference.

getExternalSubscription()

Fetch an external subscription


    public
                getExternalSubscription(string $external_subscription_id[, array<string|int, mixed> $options = [] ]) : ExternalSubscription

Parameters

$external_subscription_id : string: External subscription ID, external_id or uuid. For ID no prefix is used e.g. e28zov4fw0v2. For external_id use prefix external-id-, e.g. external-id-123456 and for uuid use prefix uuid- e.g. uuid-7293239bae62777d8c1ae044a9843633.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalSubscription —

Settings for an external subscription.

getExternalSubscriptionExternalPaymentPhase()

Fetch an external payment phase


    public
                getExternalSubscriptionExternalPaymentPhase(string $external_subscription_id, string $external_payment_phase_id[, array<string|int, mixed> $options = [] ]) : ExternalPaymentPhase

Parameters

$external_subscription_id : string: External subscription id
$external_payment_phase_id : string: External payment phase ID, e.g. a34ypb2ef9w1.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalPaymentPhase —

Details for an external payment phase.

getGeneralLedgerAccount()

Fetch a general ledger account


    public
                getGeneralLedgerAccount(string $general_ledger_account_id[, array<string|int, mixed> $options = [] ]) : GeneralLedgerAccount

Parameters

$general_ledger_account_id : string: General Ledger Account ID
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GeneralLedgerAccount —

A general ledger account.

getGiftCard()

Fetch a gift card


    public
                getGiftCard(string $gift_card_id[, array<string|int, mixed> $options = [] ]) : GiftCard

Parameters

$gift_card_id : string: Gift Card ID, e.g. e28zov4fw0v2.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GiftCard —

Gift card details

getInvoice()

Fetch an invoice


    public
                getInvoice(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

An invoice.

getInvoicePdf()

Fetch an invoice as a PDF


    public
                getInvoicePdf(string $invoice_id[, array<string|int, mixed> $options = [] ]) : BinaryFile

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BinaryFile —

An invoice as a PDF.

getInvoiceTemplate()

Fetch an invoice template


    public
                getInvoiceTemplate(string $invoice_template_id[, array<string|int, mixed> $options = [] ]) : InvoiceTemplate

Parameters

$invoice_template_id : string: Invoice template ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceTemplate —

Settings for an invoice template.

getItem()

Fetch an item


    public
                getItem(string $item_id[, array<string|int, mixed> $options = [] ]) : Item

Parameters

$item_id : string: Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Item —

An item.

getLineItem()

Fetch a line item


    public
                getLineItem(string $line_item_id[, array<string|int, mixed> $options = [] ]) : LineItem

Parameters

$line_item_id : string: Line Item ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

LineItem —

A line item.

getMeasuredUnit()

Fetch a measured unit


    public
                getMeasuredUnit(string $measured_unit_id[, array<string|int, mixed> $options = [] ]) : MeasuredUnit

Parameters

$measured_unit_id : string: Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

MeasuredUnit —

An item.

getPerformanceObligation()

Get a single Performance Obligation.


    public
                getPerformanceObligation(string $performance_obligation_id[, array<string|int, mixed> $options = [] ]) : PerformanceObligation

Parameters

$performance_obligation_id : string: Performance Obligation id.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

PerformanceObligation —

A single Performance Obligation.

getPerformanceObligations()

Get a site's Performance Obligations


    public
                getPerformanceObligations([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

A list of Performance Obligations.

getPlan()

Fetch a plan


    public
                getPlan(string $plan_id[, array<string|int, mixed> $options = [] ]) : Plan

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Plan —

A plan.

getPlanAddOn()

Fetch a plan's add-on


    public
                getPlanAddOn(string $plan_id, string $add_on_id[, array<string|int, mixed> $options = [] ]) : AddOn

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$add_on_id : string: Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AddOn —

An add-on.

getPreviewRenewal()

Fetch a preview of a subscription's renewal invoice(s)


    public
                getPreviewRenewal(string $subscription_id[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

A preview of the subscription's renewal invoice(s).

getShippingAddress()

Fetch an account's shipping address


    public
                getShippingAddress(string $account_id, string $shipping_address_id[, array<string|int, mixed> $options = [] ]) : ShippingAddress

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$shipping_address_id : string: Shipping Address ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingAddress —

A shipping address.

getShippingMethod()

Fetch a shipping method


    public
                getShippingMethod(string $shipping_method_id[, array<string|int, mixed> $options = [] ]) : ShippingMethod

Parameters

$shipping_method_id : string: Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingMethod —

A shipping method.

getSite()

Fetch a site


    public
                getSite(string $site_id[, array<string|int, mixed> $options = [] ]) : Site

Parameters

$site_id : string: Site ID or subdomain. For ID no prefix is used e.g. e28zov4fw0v2. For subdomain use prefix subdomain-, e.g. subdomain-recurly.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Site —

A site.

getSubscription()

Fetch a subscription


    public
                getSubscription(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

getSubscriptionChange()

Fetch a subscription's pending change


    public
                getSubscriptionChange(string $subscription_id[, array<string|int, mixed> $options = [] ]) : SubscriptionChange

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

SubscriptionChange —

A subscription's pending change.

getTransaction()

Fetch a transaction


    public
                getTransaction(string $transaction_id[, array<string|int, mixed> $options = [] ]) : Transaction

Parameters

$transaction_id : string: Transaction ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Transaction —

A transaction.

getUniqueCouponCode()

Fetch a unique coupon code


    public
                getUniqueCouponCode(string $unique_coupon_code_id[, array<string|int, mixed> $options = [] ]) : UniqueCouponCode

Parameters

$unique_coupon_code_id : string: Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

UniqueCouponCode —

A unique coupon code.

getUsage()

Get a usage record


    public
                getUsage(string $usage_id[, array<string|int, mixed> $options = [] ]) : Usage

Parameters

$usage_id : string: Usage Record ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Usage —

The usage record.

listAccountAcquisition()

List a site's account acquisition data


    public
                listAccountAcquisition([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the site's account acquisition data.

listAccountCouponRedemptions()

List the coupon redemptions for an account


    public
                listAccountCouponRedemptions(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of the the coupon redemptions on an account.

listAccountCreditPayments()

List an account's credit payments


    public
                listAccountCreditPayments(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the account's credit payments.

listAccountExternalAccount()

List external accounts for an account


    public
                listAccountExternalAccount(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

A list of external accounts on an account.

listAccountExternalInvoices()

List the external invoices on an account


    public
                listAccountExternalInvoices(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.

Return values

Pager —

A list of the the external_invoices on an account.

listAccountExternalSubscriptions()

List an account's external subscriptions


    public
                listAccountExternalSubscriptions(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the external_subscriptions on an account.

listAccountInvoices()

List an account's invoices


    public
                listAccountInvoices(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['state'] (string): Invoice state.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type when: - type=charge, only charge invoices will be returned. - type=credit, only credit invoices will be returned. - type=non-legacy, only charge and credit invoices will be returned. - type=legacy, only legacy invoices will be returned.

Return values

Pager —

A list of the account's invoices.

listAccountLineItems()

List an account's line items


    public
                listAccountLineItems(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['original'] (string): Filter by original field.
$options['params']['state'] (string): Filter by state field.
$options['params']['type'] (string): Filter by type field.

Return values

Pager —

A list of the account's line items.

listAccountNotes()

List an account's notes


    public
                listAccountNotes(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

Return values

Pager —

A list of an account's notes.

listAccounts()

List a site's accounts


    public
                listAccounts([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['email'] (string): Filter for accounts with this exact email address. A blank value will return accounts with both null and "" email addresses. Note that multiple accounts can share one email address.
$options['params']['subscriber'] (bool): Filter for accounts with or without a subscription in the active, canceled, or future state.
$options['params']['past_due'] (string): Filter for accounts with an invoice in the past_due state.

Return values

Pager —

A list of the site's accounts.

listAccountSubscriptions()

List an account's subscriptions


    public
                listAccountSubscriptions(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

$options['params']['state'] (string): Filter by state.

 - When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned.
 - When `state=in_trial`, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
 - When `state=live`, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.

Return values

Pager —

A list of the account's subscriptions.

listAccountTransactions()

List an account's transactions


    public
                listAccountTransactions(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type field. The value payment will return both purchase and capture transactions.
$options['params']['success'] (string): Filter by success field.

Return values

Pager —

A list of the account's transactions.

listActiveCouponRedemptions()

List the coupon redemptions that are active on an account


    public
                listActiveCouponRedemptions(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

Active coupon redemptions on an account.

listAddOns()

List a site's add-ons


    public
                listAddOns([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of add-ons.

listBillingInfos()

Get the list of billing information associated with an account


    public
                listBillingInfos(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the the billing information for an account's

listBusinessEntities()

List business entities


    public
                listBusinessEntities([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

List of all business entities on your site.

listBusinessEntityInvoices()

List a business entity's invoices


    public
                listBusinessEntityInvoices(string $business_entity_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$business_entity_id : string

Business Entity ID. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-entity1.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['state'] (string): Invoice state.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type when: - type=charge, only charge invoices will be returned. - type=credit, only credit invoices will be returned. - type=non-legacy, only charge and credit invoices will be returned. - type=legacy, only legacy invoices will be returned.

Return values

Pager —

A list of the business entity's invoices.

listChildAccounts()

List an account's child accounts


    public
                listChildAccounts(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['email'] (string): Filter for accounts with this exact email address. A blank value will return accounts with both null and "" email addresses. Note that multiple accounts can share one email address.
$options['params']['subscriber'] (bool): Filter for accounts with or without a subscription in the active, canceled, or future state.
$options['params']['past_due'] (string): Filter for accounts with an invoice in the past_due state.

Return values

Pager —

A list of an account's child accounts.

listCoupons()

List a site's coupons


    public
                listCoupons([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the site's coupons.

listCreditPayments()

List a site's credit payments


    public
                listCreditPayments([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the site's credit payments.

listCustomFieldDefinitions()

List a site's custom field definitions


    public
                listCustomFieldDefinitions([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['related_type'] (string): Filter by related type.

Return values

Pager —

A list of the site's custom field definitions.

listDunningCampaigns()

List the dunning campaigns for a site


    public
                listDunningCampaigns([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the dunning_campaigns on an account.

listEntitlements()

List entitlements granted to an account


    public
                listEntitlements(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['state'] (string): Filter the entitlements based on the state of the applicable subscription.

 - When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned.
 - When no state is provided, subscriptions with active or canceled states will be returned.

Return values

Pager —

A list of the entitlements granted to an account.

listExternalInvoices()

List the external invoices on a site


    public
                listExternalInvoices([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.

Return values

Pager —

A list of the the external_invoices on a site.

listExternalProductExternalProductReferences()

List the external product references for an external product


    public
                listExternalProductExternalProductReferences(string $external_product_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$external_product_id : string

External product id

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the external product references for an external product.

listExternalProducts()

List a site's external products


    public
                listExternalProducts([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the external_products on a site.

listExternalSubscriptionExternalInvoices()

List the external invoices on an external subscription


    public
                listExternalSubscriptionExternalInvoices(string $external_subscription_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$external_subscription_id : string

External subscription id

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.

Return values

Pager —

A list of the the external_invoices on a site.

listExternalSubscriptionExternalPaymentPhases()

List the external payment phases on an external subscription


    public
                listExternalSubscriptionExternalPaymentPhases(string $external_subscription_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$external_subscription_id : string

External subscription id

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.

Return values

Pager —

A list of the the external_payment_phases on a site.

listExternalSubscriptions()

List the external subscriptions on a site


    public
                listExternalSubscriptions([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the external_subscriptions on a site.

listGeneralLedgerAccounts()

List a site's general ledger accounts


    public
                listGeneralLedgerAccounts([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['account_type'] (string): General Ledger Account type by which to filter the response.

Return values

Pager —

A list of the site's general ledger accounts.

listGiftCards()

List gift cards


    public
                listGiftCards([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

List of all created gift cards on your site.

listInvoiceCouponRedemptions()

List the coupon redemptions applied to an invoice


    public
                listInvoiceCouponRedemptions(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$invoice_id : string

Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the the coupon redemptions associated with the invoice.

listInvoiceLineItems()

List an invoice's line items


    public
                listInvoiceLineItems(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$invoice_id : string

Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['original'] (string): Filter by original field.
$options['params']['state'] (string): Filter by state field.
$options['params']['type'] (string): Filter by type field.

Return values

Pager —

A list of the invoice's line items.

listInvoices()

List a site's invoices


    public
                listInvoices([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['state'] (string): Invoice state.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type when: - type=charge, only charge invoices will be returned. - type=credit, only credit invoices will be returned. - type=non-legacy, only charge and credit invoices will be returned. - type=legacy, only legacy invoices will be returned.

Return values

Pager —

A list of the site's invoices.

listInvoiceTemplateAccounts()

List an invoice template's associated accounts


    public
                listInvoiceTemplateAccounts(string $invoice_template_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$invoice_template_id : string

Invoice template ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['email'] (string): Filter for accounts with this exact email address. A blank value will return accounts with both null and "" email addresses. Note that multiple accounts can share one email address.
$options['params']['subscriber'] (bool): Filter for accounts with or without a subscription in the active, canceled, or future state.
$options['params']['past_due'] (string): Filter for accounts with an invoice in the past_due state.

Return values

Pager —

A list of an invoice template's associated accounts.

listInvoiceTemplates()

Show the invoice templates for a site


    public
                listInvoiceTemplates([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Return values

Pager —

A list of the the invoice templates on a site.

listItems()

List a site's items


    public
                listItems([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of the site's items.

listLineItems()

List a site's line items


    public
                listLineItems([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['original'] (string): Filter by original field.
$options['params']['state'] (string): Filter by state field.
$options['params']['type'] (string): Filter by type field.

Return values

Pager —

A list of the site's line items.

listMeasuredUnit()

List a site's measured units


    public
                listMeasuredUnit([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of the site's measured units.

listPlanAddOns()

List a plan's add-ons


    public
                listPlanAddOns(string $plan_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$plan_id : string

Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of add-ons.

listPlans()

List a site's plans


    public
                listPlans([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of plans.

listRelatedInvoices()

List an invoice's related credit or charge invoices


    public
                listRelatedInvoices(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Pager —

A list of the credit or charge invoices associated with the invoice.

listShippingAddresses()

Fetch a list of an account's shipping addresses


    public
                listShippingAddresses(string $account_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$account_id : string

Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of an account's shipping addresses.

listShippingMethods()

List a site's shipping methods


    public
                listShippingMethods([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the site's shipping methods.

listSites()

List sites


    public
                listSites([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['state'] (string): Filter by state.

Return values

Pager —

A list of sites.

listSubscriptionCouponRedemptions()

List the coupon redemptions for a subscription


    public
                listSubscriptionCouponRedemptions(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$subscription_id : string

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of the the coupon redemptions on a subscription.

listSubscriptionInvoices()

List a subscription's invoices


    public
                listSubscriptionInvoices(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$subscription_id : string

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['state'] (string): Invoice state.
$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type when: - type=charge, only charge invoices will be returned. - type=credit, only credit invoices will be returned. - type=non-legacy, only charge and credit invoices will be returned. - type=legacy, only legacy invoices will be returned.

Return values

Pager —

A list of the subscription's invoices.

listSubscriptionLineItems()

List a subscription's line items


    public
                listSubscriptionLineItems(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$subscription_id : string

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['original'] (string): Filter by original field.
$options['params']['state'] (string): Filter by state field.
$options['params']['type'] (string): Filter by type field.

Return values

Pager —

A list of the subscription's line items.

listSubscriptions()

List a site's subscriptions


    public
                listSubscriptions([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

$options['params']['state'] (string): Filter by state.

 - When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned.
 - When `state=in_trial`, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
 - When `state=live`, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.

Return values

Pager —

A list of the site's subscriptions.

listTransactions()

List a site's transactions


    public
                listTransactions([array<string|int, mixed> $options = [] ]) : Pager

Parameters

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['type'] (string): Filter by type field. The value payment will return both purchase and capture transactions.
$options['params']['success'] (string): Filter by success field.

Return values

Pager —

A list of the site's transactions.

listUniqueCouponCodes()

List unique coupon codes associated with a bulk coupon


    public
                listUniqueCouponCodes(string $coupon_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$coupon_id : string

Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by updated_at in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=created_at or sort=updated_at. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

Return values

Pager —

A list of unique coupon codes that were generated

listUsage()

List a subscription add-on's usage records


    public
                listUsage(string $subscription_id, string $add_on_id[, array<string|int, mixed> $options = [] ]) : Pager

Parameters

$subscription_id : string

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

$add_on_id : string

Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['ids'] (array): Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6.

Important notes:*

   * The `ids` parameter cannot be used with any other ordering or filtering
     parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
   * Invalid or unknown IDs will be ignored, so you should check that the
     results correspond to your request.
   * Records are returned in an arbitrary order. Since results are all
     returned at once you can sort the records yourself.

$options['params']['limit'] (int): Limit number of records 1-200.
$options['params']['order'] (string): Sort order.
$options['params']['sort'] (string): Sort field. You really only want to sort by usage_timestamp in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.
$options['params']['begin_time'] (string): Inclusively filter by begin_time when sort=usage_timestamp or sort=recorded_timestamp. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['end_time'] (string): Inclusively filter by end_time when sort=usage_timestamp or sort=recorded_timestamp. Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
$options['params']['billing_status'] (string): Filter by usage record's billing status

Return values

Pager —

A list of the subscription add-on's usage records.

markInvoiceFailed()

Mark an open invoice as failed


    public
                markInvoiceFailed(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

markInvoiceSuccessful()

Mark an open invoice as successful


    public
                markInvoiceSuccessful(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

nextPage()

Used by the \Recurly\Pager to make requests to the API.


    public
                nextPage(string $path[, array<string|int, mixed> $options = [] ]) : Page

Parameters

$path : string: The URL to make the pager request to
$options : array<string|int, mixed> = []: An associative array optional parameters

Return values

Page —

pagerCount()

Used by the \Recurly\Pager to obtain total counts from the API.


    public
                pagerCount(string $path[, array<string|int, mixed> $options = [] ]) : Response

Parameters

$path : string: The URL to make the pager request to
$options : array<string|int, mixed> = []: An associative array optional parameters

Return values

Response —

pauseSubscription()

Pause subscription


    public
                pauseSubscription(string $subscription_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

previewGiftCard()

Preview gift card


    public
                previewGiftCard(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : GiftCard

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GiftCard —

Returns the gift card

previewInvoice()

Preview new invoice for pending line items


    public
                previewInvoice(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns the invoice previews.

previewPurchase()

Preview a new purchase


    public
                previewPurchase(array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : InvoiceCollection

Parameters

$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

InvoiceCollection —

Returns preview of the new invoices

previewSubscriptionChange()

Preview a new subscription change


    public
                previewSubscriptionChange(string $subscription_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : SubscriptionChange

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

SubscriptionChange —

A subscription change.

putDunningCampaignBulkUpdate()

Assign a dunning campaign to multiple plans


    public
                putDunningCampaignBulkUpdate(string $dunning_campaign_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : DunningCampaignsBulkUpdateResponse

Parameters

$dunning_campaign_id : string: Dunning Campaign ID, e.g. e28zov4fw0v2.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

DunningCampaignsBulkUpdateResponse —

A list of updated plans.

putExternalSubscription()

Update an external subscription


    public
                putExternalSubscription(string $external_subscription_id[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $options = [] ]) : ExternalSubscription

Parameters

$external_subscription_id : string: External subscription id
$body : array<string|int, mixed> = []: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalSubscription —

Settings for an external subscription.

reactivateAccount()

Reactivate an inactive account


    public
                reactivateAccount(string $account_id[, array<string|int, mixed> $options = [] ]) : Account

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Account —

An account.

reactivateItem()

Reactivate an inactive item


    public
                reactivateItem(string $item_id[, array<string|int, mixed> $options = [] ]) : Item

Parameters

$item_id : string: Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Item —

An item.

reactivateSubscription()

Reactivate a canceled subscription


    public
                reactivateSubscription(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

An active subscription.

reactivateUniqueCouponCode()

Restore a unique coupon code


    public
                reactivateUniqueCouponCode(string $unique_coupon_code_id[, array<string|int, mixed> $options = [] ]) : UniqueCouponCode

Parameters

$unique_coupon_code_id : string: Unique Coupon Code ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-abc-8dh2-def.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

UniqueCouponCode —

A unique coupon code.

recordExternalTransaction()

Record an external payment for a manual invoices.


    public
                recordExternalTransaction(string $invoice_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Transaction

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Transaction —

The recorded transaction.

redeemGiftCard()

Redeem gift card


    public
                redeemGiftCard(string $redemption_code, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : GiftCard

Parameters

$redemption_code : string: Gift Card redemption code, e.g., N1A2T8IRXSCMO40V.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GiftCard —

Redeems and returns the gift card

refundInvoice()

Refund an invoice


    public
                refundInvoice(string $invoice_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

Returns the new credit invoice.

removeABillingInfo()

Remove an account's billing information


    public
                removeABillingInfo(string $account_id, string $billing_info_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$billing_info_id : string: Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Billing information deleted

removeAccountAcquisition()

Remove an account's acquisition data


    public
                removeAccountAcquisition(string $account_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Acquisition data was succesfully deleted.

removeBillingInfo()

Remove an account's billing information


    public
                removeBillingInfo(string $account_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Billing information deleted

removeCouponRedemption()

Delete the active coupon redemption from an account


    public
                removeCouponRedemption(string $account_id[, array<string|int, mixed> $options = [] ]) : CouponRedemption

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

CouponRedemption —

Coupon redemption deleted.

removeLineItem()

Delete an uninvoiced line item


    public
                removeLineItem(string $line_item_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$line_item_id : string: Line Item ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Line item deleted.

removeMeasuredUnit()

Remove a measured unit


    public
                removeMeasuredUnit(string $measured_unit_id[, array<string|int, mixed> $options = [] ]) : MeasuredUnit

Parameters

$measured_unit_id : string: Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

MeasuredUnit —

A measured unit.

removePlan()

Remove a plan


    public
                removePlan(string $plan_id[, array<string|int, mixed> $options = [] ]) : Plan

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Plan —

Plan deleted

removePlanAddOn()

Remove an add-on


    public
                removePlanAddOn(string $plan_id, string $add_on_id[, array<string|int, mixed> $options = [] ]) : AddOn

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$add_on_id : string: Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AddOn —

Add-on deleted

removeShippingAddress()

Remove an account's shipping address


    public
                removeShippingAddress(string $account_id, string $shipping_address_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$shipping_address_id : string: Shipping Address ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Shipping address deleted.

removeSubscriptionChange()

Delete the pending subscription change


    public
                removeSubscriptionChange(string $subscription_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Subscription change was deleted.

removeUsage()

Delete a usage record.


    public
                removeUsage(string $usage_id[, array<string|int, mixed> $options = [] ]) : EmptyResource

Parameters

$usage_id : string: Usage Record ID.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

EmptyResource —

Usage was successfully deleted.

reopenInvoice()

Reopen a closed, manual invoice


    public
                reopenInvoice(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

restoreCoupon()

Restore an inactive coupon


    public
                restoreCoupon(string $coupon_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Coupon

Parameters

$coupon_id : string: Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Coupon —

The restored coupon.

resumeSubscription()

Resume subscription


    public
                resumeSubscription(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

showExternalInvoice()

Fetch an external invoice


    public
                showExternalInvoice(string $external_invoice_id[, array<string|int, mixed> $options = [] ]) : ExternalInvoice

Parameters

$external_invoice_id : string: External invoice ID, e.g. e28zov4fw0v2.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalInvoice —

Returns the external invoice

terminateSubscription()

Terminate a subscription


    public
                terminateSubscription(string $subscription_id[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

$options : array<string|int, mixed> = []

Associative array of optional parameters

Supported optional query string parameters:

$options['params']['refund'] (string): The type of refund to perform:

 * `full` - Performs a full refund of the last invoice for the current subscription term.
 * `partial` - Prorates a refund based on the amount of time remaining in the current bill cycle.
 * `none` - Terminates the subscription without a refund.

 In the event that the most recent invoice is a $0 invoice paid entirely by credit, Recurly will apply the credit back to the customer’s account.

 You may also terminate a subscription with no refund and then manually refund specific invoices.

$options['params']['charge'] (bool): Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.

Return values

Subscription —

An expired subscription.

updateABillingInfo()

Update an account's billing information


    public
                updateABillingInfo(string $account_id, string $billing_info_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : BillingInfo

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$billing_info_id : string: Billing Info ID. Can ONLY be used for sites utilizing the Wallet feature.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BillingInfo —

Updated billing information.

updateAccount()

Update an account


    public
                updateAccount(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Account

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Account —

An account.

updateAccountAcquisition()

Update an account's acquisition data


    public
                updateAccountAcquisition(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : AccountAcquisition

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AccountAcquisition —

An account's updated acquisition data.

updateAccountExternalAccount()

Update an external account


    public
                updateAccountExternalAccount(string $account_id, string $external_account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalAccount

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$external_account_id : string: External account ID, e.g. s28zov4fw0cb.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalAccount —

A representation of the updated external_account.

updateBillingInfo()

Set an account's billing information


    public
                updateBillingInfo(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : BillingInfo

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

BillingInfo —

Updated billing information.

updateCoupon()

Update an active coupon


    public
                updateCoupon(string $coupon_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Coupon

Parameters

$coupon_id : string: Coupon ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-10off.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Coupon —

The updated coupon.

updateExternalProduct()

Update an external product


    public
                updateExternalProduct(string $external_product_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ExternalProduct

Parameters

$external_product_id : string: External product id
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ExternalProduct —

Settings for an external product.

updateGeneralLedgerAccount()

Update a general ledger account


    public
                updateGeneralLedgerAccount(string $general_ledger_account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : GeneralLedgerAccount

Parameters

$general_ledger_account_id : string: General Ledger Account ID
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

GeneralLedgerAccount —

The updated general ledger account.

updateInvoice()

Update an invoice


    public
                updateInvoice(string $invoice_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

An invoice.

updateItem()

Update an active item


    public
                updateItem(string $item_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Item

Parameters

$item_id : string: Item ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-red.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Item —

The updated item.

updateMeasuredUnit()

Update a measured unit


    public
                updateMeasuredUnit(string $measured_unit_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : MeasuredUnit

Parameters

$measured_unit_id : string: Measured unit ID or name. For ID no prefix is used e.g. e28zov4fw0v2. For name use prefix name-, e.g. name-Storage.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

MeasuredUnit —

The updated measured_unit.

updatePlan()

Update a plan


    public
                updatePlan(string $plan_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Plan

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Plan —

A plan.

updatePlanAddOn()

Update an add-on


    public
                updatePlanAddOn(string $plan_id, string $add_on_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : AddOn

Parameters

$plan_id : string: Plan ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$add_on_id : string: Add-on ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-gold.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

AddOn —

An add-on.

updateShippingAddress()

Update an account's shipping address


    public
                updateShippingAddress(string $account_id, string $shipping_address_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ShippingAddress

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$shipping_address_id : string: Shipping Address ID.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingAddress —

The updated shipping address.

updateShippingMethod()

Update an active Shipping Method


    public
                updateShippingMethod(string $shipping_method_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : ShippingMethod

Parameters

$shipping_method_id : string: Shipping Method ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-usps_2-day.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

ShippingMethod —

The updated shipping method.

updateSubscription()

Update a subscription


    public
                updateSubscription(string $subscription_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Subscription

Parameters

$subscription_id : string: Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Subscription —

A subscription.

updateUsage()

Update a usage record


    public
                updateUsage(string $usage_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Usage

Parameters

$usage_id : string: Usage Record ID.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Usage —

The updated usage record.

verifyBillingInfo()

Verify an account's credit card billing information


    public
                verifyBillingInfo(string $account_id[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $options = [] ]) : Transaction

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed> = []: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Transaction —

Transaction information from verify.

verifyBillingInfoCvv()

Verify an account's credit card billing cvv


    public
                verifyBillingInfoCvv(string $account_id, array<string|int, mixed> $body[, array<string|int, mixed> $options = [] ]) : Transaction

Parameters

$account_id : string: Account ID or code. For ID no prefix is used e.g. e28zov4fw0v2. For code use prefix code-, e.g. code-bob.
$body : array<string|int, mixed>: The body of the request.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Transaction —

Transaction information from verify.

voidInvoice()

Void a credit invoice.


    public
                voidInvoice(string $invoice_id[, array<string|int, mixed> $options = [] ]) : Invoice

Parameters

$invoice_id : string: Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000.
$options : array<string|int, mixed> = []: Associative array of optional parameters

Return values

Invoice —

The updated invoice.

apiVersion()

The Recurly openapi spec version that this client library was generated for.


    protected
                apiVersion() : string

Return values

string —

The openapi spec version

encodeApiKey()

Base64 encodes the API key


    protected
            static    encodeApiKey(string $key) : string

Parameters

$key : string: The API key to encode

Return values

string —

base64 encoded API key

getUserAgent()

Generates User-Agent for API requests


    protected
            static    getUserAgent() : string

Return values

string —

Recurly client User-Agent string

interpolatePath()

Replaces placeholder values with supplied values


    protected
                interpolatePath(string $path[, array<string|int, mixed> $options = [] ]) : string

Parameters

$path : string: Tokenized path to make replacements on
$options : array<string|int, mixed> = []: Associatve array of tokens and their replacement values

Return values

string —

The path with it's tokens replaced with the supplied values

makeRequest()

Performs API requests and processes the response into a Recurly Resource


    protected
                makeRequest(string $method, string $path[, array<string|int, mixed> $body = [] ][, array<string|int, mixed> $options = [] ]) : RecurlyResource

Parameters

$method : string: HTTP method to use
$path : string: Tokenized path to request
$body : array<string|int, mixed> = []: The request body
$options : array<string|int, mixed> = []: Additional request parameters (including query parameters)

Return values

RecurlyResource —

A Recurly Resource

titleize()

Capitalizes all the words in the $input.


    protected
            static    titleize(string $input[, string $prefix = '' ]) : string

Parameters

$input : string: The string to titleize
$prefix : string = '': (optional) Prefix to add to the beginning of the titleized string. The prefix will not be titleized.

Return values

string —

The titleized $input wtih the prepended $prefix

_buildPath()

Build the URL that the API request will be sent to


    private
                _buildPath(string $path, array<string|int, mixed> $options) : string

Parameters

$path : string: The path to be requested
$options : array<string|int, mixed>: Additional request parameters (including query parameters)

Return values

string —

The combined URL

_coreHeaders()

Generates core headers to be sent with the HTTP request


    private
                _coreHeaders() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array representation of the core request HTTP headers

_formatDateTimes()

Converts any DateTime values in $arr to ISO8601 strings


    private
                _formatDateTimes(array<string|int, mixed> $arr) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>: The Associative array to format

Return values

array<string|int, mixed> —

The formatted array

_getResponse()

Performs the HTTP request to the Recurly API


    private
                _getResponse(Request $request) : Response

Parameters

$request : Request: The \Recurly\Request object

Return values

Response —

A Recurly Response object

_mapArrayParams()

Maps parameters with array values into csv strings. The API expects these values to be csv strings, but an array is a nicer interface for developers.


    private
                _mapArrayParams([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Associative array of parameters

Return values

array<string|int, mixed> —

_mapBooleanParams()

Maps parameters with boolean value into strings. The API expects these values to be booleans, but http_build_query transforms actual php booleans into integers. So the workaround is to provide them as strings instead.


    private
                _mapBooleanParams([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$params : array<string|int, mixed> = []: Associative array of parameters

Return values

array<string|int, mixed> —

_validateOptions()

Checks that $options keys are valid


    private
                _validateOptions([array<string|int, mixed> $options = [] ]) : void

Parameters

$options : array<string|int, mixed> = []: An associative array optional parameters

Return values

void —

_validatePathParameters()

Checks that path parameters are valid


    private
                _validatePathParameters([array<string|int, mixed> $options = [] ]) : void

Parameters

$options : array<string|int, mixed> = []: Associatve array of tokens and their replacement values

Return values

void —

Client extends BaseClient

Table of Contents

Constants

ALLOWED_OPTIONS

API_HOSTS

Properties

$baseUrl

$http

$_api_key

$_logger

Methods

__construct()

Parameters

Return values

applyCreditBalance()

Parameters

Tags

Return values

cancelpurchase()

Parameters

Tags

Return values

cancelSubscription()

Parameters

Tags

Return values

collectInvoice()

Parameters

Tags

Return values

convertTrial()

Parameters

Tags

Return values

createAccount()

Parameters

Tags

Return values

createAccountExternalAccount()

Parameters

Tags

Return values

createAuthorizePurchase()

Parameters

Tags

Return values

createBillingInfo()

Parameters

Tags

Return values

createCapturePurchase()

Parameters

Tags

Return values

createCoupon()

Parameters

Tags

Return values

createCouponRedemption()

Parameters

Tags

Return values

createExternalProduct()

Parameters

Tags

Return values

createExternalProductExternalProductReference()

Parameters

Tags

Return values

createExternalSubscription()

Parameters

Tags

Return values

createGeneralLedgerAccount()

Parameters

Tags

Return values

createGiftCard()

Parameters