code
stringlengths 15
9.96M
| docstring
stringlengths 1
10.1k
| func_name
stringlengths 1
124
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 6
186
| url
stringlengths 50
236
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/reporting/report_types/%s', $id), $params, $opts);
} | Retrieves the details of a Report Type. (Certain report types require a <a
href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Reporting\ReportType
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Reporting/ReportTypeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Reporting/ReportTypeService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/reporting/report_runs', $params, $opts);
} | Returns a list of Report Runs, with the most recent appearing first.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Reporting\ReportRun>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Reporting/ReportRunService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Reporting/ReportRunService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/reporting/report_runs', $params, $opts);
} | Creates a new object and begin running the report. (Certain report types require
a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
@param null|array{expand?: string[], parameters?: array{columns?: string[], connected_account?: string, currency?: string, interval_end?: int, interval_start?: int, payout?: string, reporting_category?: string, timezone?: string}, report_type: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Reporting\ReportRun
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Reporting/ReportRunService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Reporting/ReportRunService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/reporting/report_runs/%s', $id), $params, $opts);
} | Retrieves the details of an existing Report Run.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Reporting\ReportRun
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Reporting/ReportRunService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Reporting/ReportRunService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/forwarding/requests', $params, $opts);
} | Lists all ForwardingRequest objects.
@param null|array{created?: array{gt?: int, gte?: int, lt?: int, lte?: int}, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Forwarding\Request>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Forwarding/RequestService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Forwarding/RequestService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/forwarding/requests', $params, $opts);
} | Creates a ForwardingRequest object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, payment_method: string, replacements: string[], request: array{body?: string, headers?: array{name: string, value: string}[]}, url: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Forwarding\Request
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Forwarding/RequestService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Forwarding/RequestService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/forwarding/requests/%s', $id), $params, $opts);
} | Retrieves a ForwardingRequest object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Forwarding\Request
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Forwarding/RequestService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Forwarding/RequestService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/debit_reversals', $params, $opts);
} | Returns a list of DebitReversals.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, received_debit?: string, resolution?: string, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\DebitReversal>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/DebitReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/DebitReversalService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/debit_reversals', $params, $opts);
} | Reverses a ReceivedDebit and creates a DebitReversal object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, received_debit: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\DebitReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/DebitReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/DebitReversalService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/debit_reversals/%s', $id), $params, $opts);
} | Retrieves a DebitReversal object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\DebitReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/DebitReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/DebitReversalService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/received_credits', $params, $opts);
} | Returns a list of ReceivedCredits.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, linked_flows?: array{source_flow_type: string}, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\ReceivedCredit>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/ReceivedCreditService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/ReceivedCreditService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/received_credits/%s', $id), $params, $opts);
} | Retrieves the details of an existing ReceivedCredit by passing the unique
ReceivedCredit ID from the ReceivedCredit list.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\ReceivedCredit
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/ReceivedCreditService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/ReceivedCreditService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/outbound_payments', $params, $opts);
} | Returns a list of OutboundPayments sent from the specified FinancialAccount.
@param null|array{created?: array|int, customer?: string, ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\OutboundPayment>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundPaymentService.php | MIT |
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/outbound_payments/%s/cancel', $id), $params, $opts);
} | Cancel an OutboundPayment.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Service/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundPaymentService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/outbound_payments', $params, $opts);
} | Creates an OutboundPayment.
@param null|array{amount: int, currency: string, customer?: string, description?: string, destination_payment_method?: string, destination_payment_method_data?: array{billing_details?: array{address?: null|array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, email?: null|string, name?: null|string, phone?: null|string, tax_id?: string}, financial_account?: string, metadata?: \Stripe\StripeObject, type: string, us_bank_account?: array{account_holder_type?: string, account_number?: string, account_type?: string, financial_connections_account?: string, routing_number?: string}}, destination_payment_method_options?: array{us_bank_account?: null|array{network?: string}}, end_user_details?: array{ip_address?: string, present: bool}, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, statement_descriptor?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundPaymentService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/outbound_payments/%s', $id), $params, $opts);
} | Retrieves the details of an existing OutboundPayment by passing the unique
OutboundPayment ID from either the OutboundPayment creation request or
OutboundPayment list.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundPayment
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/OutboundPaymentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundPaymentService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/financial_accounts', $params, $opts);
} | Returns a list of FinancialAccounts.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\FinancialAccount>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function close($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/financial_accounts/%s/close', $id), $params, $opts);
} | Closes a FinancialAccount. A FinancialAccount can only be closed if it has a
zero balance, has no pending InboundTransfers, and has canceled all attached
Issuing cards.
@param string $id
@param null|array{expand?: string[], forwarding_settings?: array{financial_account?: string, payment_method?: string, type: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccount
@throws \Stripe\Exception\ApiErrorException if the request fails | close | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/financial_accounts', $params, $opts);
} | Creates a new FinancialAccount. Each connected account can have up to three
FinancialAccounts by default.
@param null|array{expand?: string[], features?: array{card_issuing?: array{requested: bool}, deposit_insurance?: array{requested: bool}, financial_addresses?: array{aba?: array{requested: bool}}, inbound_transfers?: array{ach?: array{requested: bool}}, intra_stripe_flows?: array{requested: bool}, outbound_payments?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}, outbound_transfers?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}}, metadata?: \Stripe\StripeObject, nickname?: null|string, platform_restrictions?: array{inbound_flows?: string, outbound_flows?: string}, supported_currencies: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccount
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/financial_accounts/%s', $id), $params, $opts);
} | Retrieves the details of a FinancialAccount.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccount
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function retrieveFeatures($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/financial_accounts/%s/features', $id), $params, $opts);
} | Retrieves Features information associated with the FinancialAccount.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccountFeatures
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieveFeatures | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/financial_accounts/%s', $id), $params, $opts);
} | Updates the details of a FinancialAccount.
@param string $id
@param null|array{expand?: string[], features?: array{card_issuing?: array{requested: bool}, deposit_insurance?: array{requested: bool}, financial_addresses?: array{aba?: array{requested: bool}}, inbound_transfers?: array{ach?: array{requested: bool}}, intra_stripe_flows?: array{requested: bool}, outbound_payments?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}, outbound_transfers?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}}, forwarding_settings?: array{financial_account?: string, payment_method?: string, type: string}, metadata?: \Stripe\StripeObject, nickname?: null|string, platform_restrictions?: array{inbound_flows?: string, outbound_flows?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccount
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function updateFeatures($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/financial_accounts/%s/features', $id), $params, $opts);
} | Updates the Features associated with a FinancialAccount.
@param string $id
@param null|array{card_issuing?: array{requested: bool}, deposit_insurance?: array{requested: bool}, expand?: string[], financial_addresses?: array{aba?: array{requested: bool}}, inbound_transfers?: array{ach?: array{requested: bool}}, intra_stripe_flows?: array{requested: bool}, outbound_payments?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}, outbound_transfers?: array{ach?: array{requested: bool}, us_domestic_wire?: array{requested: bool}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\FinancialAccountFeatures
@throws \Stripe\Exception\ApiErrorException if the request fails | updateFeatures | php | stripe/stripe-php | lib/Service/Treasury/FinancialAccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/FinancialAccountService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/transactions', $params, $opts);
} | Retrieves a list of Transaction objects.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], financial_account: string, limit?: int, order_by?: string, starting_after?: string, status?: string, status_transitions?: array{posted_at?: array|int}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\Transaction>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/TransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/transactions/%s', $id), $params, $opts);
} | Retrieves the details of an existing Transaction.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/TransactionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/outbound_transfers', $params, $opts);
} | Returns a list of OutboundTransfers sent from the specified FinancialAccount.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\OutboundTransfer>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundTransferService.php | MIT |
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/outbound_transfers/%s/cancel', $id), $params, $opts);
} | An OutboundTransfer can be canceled if the funds have not yet been paid out.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Service/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundTransferService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/outbound_transfers', $params, $opts);
} | Creates an OutboundTransfer.
@param null|array{amount: int, currency: string, description?: string, destination_payment_method?: string, destination_payment_method_data?: array{financial_account?: string, type: string}, destination_payment_method_options?: array{us_bank_account?: null|array{network?: string}}, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, statement_descriptor?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundTransferService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/outbound_transfers/%s', $id), $params, $opts);
} | Retrieves the details of an existing OutboundTransfer by passing the unique
OutboundTransfer ID from either the OutboundTransfer creation request or
OutboundTransfer list.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\OutboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/OutboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/OutboundTransferService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/credit_reversals', $params, $opts);
} | Returns a list of CreditReversals.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, received_credit?: string, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\CreditReversal>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/CreditReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/CreditReversalService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/credit_reversals', $params, $opts);
} | Reverses a ReceivedCredit and creates a CreditReversal object.
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, received_credit: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\CreditReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/CreditReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/CreditReversalService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/credit_reversals/%s', $id), $params, $opts);
} | Retrieves the details of an existing CreditReversal by passing the unique
CreditReversal ID from either the CreditReversal creation request or
CreditReversal list.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\CreditReversal
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/CreditReversalService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/CreditReversalService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/inbound_transfers', $params, $opts);
} | Returns a list of InboundTransfers sent from the specified FinancialAccount.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\InboundTransfer>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/InboundTransferService.php | MIT |
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/treasury/inbound_transfers/%s/cancel', $id), $params, $opts);
} | Cancels an InboundTransfer.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Service/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/InboundTransferService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/treasury/inbound_transfers', $params, $opts);
} | Creates an InboundTransfer.
@param null|array{amount: int, currency: string, description?: string, expand?: string[], financial_account: string, metadata?: \Stripe\StripeObject, origin_payment_method: string, statement_descriptor?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/InboundTransferService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/inbound_transfers/%s', $id), $params, $opts);
} | Retrieves the details of an existing InboundTransfer.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\InboundTransfer
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/InboundTransferService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/InboundTransferService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/received_debits', $params, $opts);
} | Returns a list of ReceivedDebits.
@param null|array{ending_before?: string, expand?: string[], financial_account: string, limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\ReceivedDebit>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/ReceivedDebitService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/ReceivedDebitService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/received_debits/%s', $id), $params, $opts);
} | Retrieves the details of an existing ReceivedDebit by passing the unique
ReceivedDebit ID from the ReceivedDebit list.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\ReceivedDebit
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/ReceivedDebitService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/ReceivedDebitService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/treasury/transaction_entries', $params, $opts);
} | Retrieves a list of TransactionEntry objects.
@param null|array{created?: array|int, effective_at?: array|int, ending_before?: string, expand?: string[], financial_account: string, limit?: int, order_by?: string, starting_after?: string, transaction?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Treasury\TransactionEntry>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Treasury/TransactionEntryService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/TransactionEntryService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/treasury/transaction_entries/%s', $id), $params, $opts);
} | Retrieves a TransactionEntry object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Treasury\TransactionEntry
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Treasury/TransactionEntryService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Treasury/TransactionEntryService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing_portal/sessions', $params, $opts);
} | Creates a session of the customer portal.
@param null|array{configuration?: string, customer: string, expand?: string[], flow_data?: array{after_completion?: array{hosted_confirmation?: array{custom_message?: string}, redirect?: array{return_url: string}, type: string}, subscription_cancel?: array{retention?: array{coupon_offer: array{coupon: string}, type: string}, subscription: string}, subscription_update?: array{subscription: string}, subscription_update_confirm?: array{discounts?: array{coupon?: string, promotion_code?: string}[], items: array{id: string, price?: string, quantity?: int}[], subscription: string}, type: string}, locale?: string, on_behalf_of?: string, return_url?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\BillingPortal\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/BillingPortal/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BillingPortal/SessionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/billing_portal/configurations', $params, $opts);
} | Returns a list of configurations that describe the functionality of the customer
portal.
@param null|array{active?: bool, ending_before?: string, expand?: string[], is_default?: bool, limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\BillingPortal\Configuration>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/BillingPortal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BillingPortal/ConfigurationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing_portal/configurations', $params, $opts);
} | Creates a configuration that describes the functionality and behavior of a
PortalSession.
@param null|array{business_profile?: array{headline?: null|string, privacy_policy_url?: string, terms_of_service_url?: string}, default_return_url?: null|string, expand?: string[], features: array{customer_update?: array{allowed_updates?: null|string[], enabled: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options: null|string[]}, enabled: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: \Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\BillingPortal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/BillingPortal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BillingPortal/ConfigurationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/billing_portal/configurations/%s', $id), $params, $opts);
} | Retrieves a configuration that describes the functionality of the customer
portal.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\BillingPortal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/BillingPortal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BillingPortal/ConfigurationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing_portal/configurations/%s', $id), $params, $opts);
} | Updates a configuration that describes the functionality of the customer portal.
@param string $id
@param null|array{active?: bool, business_profile?: array{headline?: null|string, privacy_policy_url?: null|string, terms_of_service_url?: null|string}, default_return_url?: null|string, expand?: string[], features?: array{customer_update?: array{allowed_updates?: null|string[], enabled?: bool}, invoice_history?: array{enabled: bool}, payment_method_update?: array{enabled: bool}, subscription_cancel?: array{cancellation_reason?: array{enabled: bool, options?: null|string[]}, enabled?: bool, mode?: string, proration_behavior?: string}, subscription_update?: array{default_allowed_updates?: null|string[], enabled?: bool, products?: null|array{prices: string[], product: string}[], proration_behavior?: string, schedule_at_period_end?: array{conditions?: null|array{type: string}[]}}}, login_page?: array{enabled: bool}, metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\BillingPortal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/BillingPortal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BillingPortal/ConfigurationService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/checkout/sessions', $params, $opts);
} | Returns a list of Checkout Sessions.
@param null|array{created?: array|int, customer?: string, customer_details?: array{email: string}, ending_before?: string, expand?: string[], limit?: int, payment_intent?: string, payment_link?: string, starting_after?: string, status?: string, subscription?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Checkout\Session>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function allLineItems($id, $params = null, $opts = null)
{
return $this->requestCollection('get', $this->buildPath('/v1/checkout/sessions/%s/line_items', $id), $params, $opts);
} | When retrieving a Checkout Session, there is an includable
<strong>line_items</strong> property containing the first handful of those
items. There is also a URL where you can retrieve the full (paginated) list of
line items.
@param string $id
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\LineItem>
@throws \Stripe\Exception\ApiErrorException if the request fails | allLineItems | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/checkout/sessions', $params, $opts);
} | Creates a Checkout Session object.
@param null|array{adaptive_pricing?: array{enabled?: bool}, after_expiration?: array{recovery?: array{allow_promotion_codes?: bool, enabled: bool}}, allow_promotion_codes?: bool, automatic_tax?: array{enabled: bool, liability?: array{account?: string, type: string}}, billing_address_collection?: string, cancel_url?: string, client_reference_id?: string, consent_collection?: array{payment_method_reuse_agreement?: array{position: string}, promotions?: string, terms_of_service?: string}, currency?: string, custom_fields?: array{dropdown?: array{default_value?: string, options: array{label: string, value: string}[]}, key: string, label: array{custom: string, type: string}, numeric?: array{default_value?: string, maximum_length?: int, minimum_length?: int}, optional?: bool, text?: array{default_value?: string, maximum_length?: int, minimum_length?: int}, type: string}[], custom_text?: array{after_submit?: null|array{message: string}, shipping_address?: null|array{message: string}, submit?: null|array{message: string}, terms_of_service_acceptance?: null|array{message: string}}, customer?: string, customer_creation?: string, customer_email?: string, customer_update?: array{address?: string, name?: string, shipping?: string}, discounts?: array{coupon?: string, promotion_code?: string}[], expand?: string[], expires_at?: int, invoice_creation?: array{enabled: bool, invoice_data?: array{account_tax_ids?: null|string[], custom_fields?: null|array{name: string, value: string}[], description?: string, footer?: string, issuer?: array{account?: string, type: string}, metadata?: \Stripe\StripeObject, rendering_options?: null|array{amount_tax_display?: null|string}}}, line_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, dynamic_tax_rates?: string[], price?: string, price_data?: array{currency: string, product?: string, product_data?: array{description?: string, images?: string[], metadata?: \Stripe\StripeObject, name: string, tax_code?: string}, recurring?: array{interval: string, interval_count?: int}, tax_behavior?: string, unit_amount?: int, unit_amount_decimal?: string}, quantity?: int, tax_rates?: string[]}[], locale?: string, metadata?: \Stripe\StripeObject, mode?: string, optional_items?: array{adjustable_quantity?: array{enabled: bool, maximum?: int, minimum?: int}, price: string, quantity: int}[], payment_intent_data?: array{application_fee_amount?: int, capture_method?: string, description?: string, metadata?: \Stripe\StripeObject, on_behalf_of?: string, receipt_email?: string, setup_future_usage?: string, shipping?: array{address: array{city?: string, country?: string, line1: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string}, payment_method_collection?: string, payment_method_configuration?: string, payment_method_data?: array{allow_redisplay?: string}, payment_method_options?: array{acss_debit?: array{currency?: string, mandate_options?: array{custom_mandate_url?: null|string, default_for?: string[], interval_description?: string, payment_schedule?: string, transaction_type?: string}, setup_future_usage?: string, target_date?: string, verification_method?: string}, affirm?: array{setup_future_usage?: string}, afterpay_clearpay?: array{setup_future_usage?: string}, alipay?: array{setup_future_usage?: string}, amazon_pay?: array{setup_future_usage?: string}, au_becs_debit?: array{setup_future_usage?: string, target_date?: string}, bacs_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: string, target_date?: string}, bancontact?: array{setup_future_usage?: string}, boleto?: array{expires_after_days?: int, setup_future_usage?: string}, card?: array{installments?: array{enabled?: bool}, request_extended_authorization?: string, request_incremental_authorization?: string, request_multicapture?: string, request_overcapture?: string, request_three_d_secure?: string, restrictions?: array{brands_blocked?: string[]}, setup_future_usage?: string, statement_descriptor_suffix_kana?: string, statement_descriptor_suffix_kanji?: string}, cashapp?: array{setup_future_usage?: string}, customer_balance?: array{bank_transfer?: array{eu_bank_transfer?: array{country: string}, requested_address_types?: string[], type: string}, funding_type?: string, setup_future_usage?: string}, eps?: array{setup_future_usage?: string}, fpx?: array{setup_future_usage?: string}, giropay?: array{setup_future_usage?: string}, grabpay?: array{setup_future_usage?: string}, ideal?: array{setup_future_usage?: string}, kakao_pay?: array{capture_method?: string, setup_future_usage?: string}, klarna?: array{setup_future_usage?: string}, konbini?: array{expires_after_days?: int, setup_future_usage?: string}, kr_card?: array{capture_method?: string, setup_future_usage?: string}, link?: array{setup_future_usage?: string}, mobilepay?: array{setup_future_usage?: string}, multibanco?: array{setup_future_usage?: string}, naver_pay?: array{capture_method?: string, setup_future_usage?: string}, oxxo?: array{expires_after_days?: int, setup_future_usage?: string}, p24?: array{setup_future_usage?: string, tos_shown_and_accepted?: bool}, pay_by_bank?: array{}, payco?: array{capture_method?: string}, paynow?: array{setup_future_usage?: string}, paypal?: array{capture_method?: null|string, preferred_locale?: string, reference?: string, risk_correlation_id?: string, setup_future_usage?: null|string}, pix?: array{expires_after_seconds?: int}, revolut_pay?: array{setup_future_usage?: string}, samsung_pay?: array{capture_method?: string}, sepa_debit?: array{mandate_options?: array{reference_prefix?: null|string}, setup_future_usage?: string, target_date?: string}, sofort?: array{setup_future_usage?: string}, swish?: array{reference?: string}, us_bank_account?: array{financial_connections?: array{permissions?: string[], prefetch?: string[]}, setup_future_usage?: string, target_date?: string, verification_method?: string}, wechat_pay?: array{app_id?: string, client: string, setup_future_usage?: string}}, payment_method_types?: string[], permissions?: array{update_shipping_details?: string}, phone_number_collection?: array{enabled: bool}, redirect_on_completion?: string, return_url?: string, saved_payment_method_options?: array{allow_redisplay_filters?: string[], payment_method_save?: string}, setup_intent_data?: array{description?: string, metadata?: \Stripe\StripeObject, on_behalf_of?: string}, shipping_address_collection?: array{allowed_countries: string[]}, shipping_options?: array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[], submit_type?: string, subscription_data?: array{application_fee_percent?: float, billing_cycle_anchor?: int, default_tax_rates?: string[], description?: string, invoice_settings?: array{issuer?: array{account?: string, type: string}}, metadata?: \Stripe\StripeObject, on_behalf_of?: string, proration_behavior?: string, transfer_data?: array{amount_percent?: float, destination: string}, trial_end?: int, trial_period_days?: int, trial_settings?: array{end_behavior: array{missing_payment_method: string}}}, success_url?: string, tax_id_collection?: array{enabled: bool, required?: string}, ui_mode?: string, wallet_options?: array{link?: array{display?: string}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Checkout\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function expire($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/checkout/sessions/%s/expire', $id), $params, $opts);
} | A Checkout Session can be expired when it is in one of these statuses:
<code>open</code>
After it expires, a customer can’t complete a Checkout Session and customers
loading the Checkout Session see a message saying the Checkout Session is
expired.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Checkout\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | expire | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/checkout/sessions/%s', $id), $params, $opts);
} | Retrieves a Checkout Session object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Checkout\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/checkout/sessions/%s', $id), $params, $opts);
} | Updates a Checkout Session object.
@param string $id
@param null|array{collected_information?: array{shipping_details?: array{address: array{city?: string, country: string, line1: string, line2?: string, postal_code?: string, state?: string}, name: string}}, expand?: string[], metadata?: null|\Stripe\StripeObject, shipping_options?: null|array{shipping_rate?: string, shipping_rate_data?: array{delivery_estimate?: array{maximum?: array{unit: string, value: int}, minimum?: array{unit: string, value: int}}, display_name: string, fixed_amount?: array{amount: int, currency: string, currency_options?: \Stripe\StripeObject}, metadata?: \Stripe\StripeObject, tax_behavior?: string, tax_code?: string, type?: string}}[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Checkout\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Checkout/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Checkout/SessionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/entitlements/features', $params, $opts);
} | Retrieve a list of features.
@param null|array{archived?: bool, ending_before?: string, expand?: string[], limit?: int, lookup_key?: string, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Entitlements\Feature>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Entitlements/FeatureService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/FeatureService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/entitlements/features', $params, $opts);
} | Creates a feature.
@param null|array{expand?: string[], lookup_key: string, metadata?: \Stripe\StripeObject, name: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Entitlements\Feature
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Entitlements/FeatureService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/FeatureService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/entitlements/features/%s', $id), $params, $opts);
} | Retrieves a feature.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Entitlements\Feature
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Entitlements/FeatureService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/FeatureService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/entitlements/features/%s', $id), $params, $opts);
} | Update a feature’s metadata or permanently deactivate it.
@param string $id
@param null|array{active?: bool, expand?: string[], metadata?: null|\Stripe\StripeObject, name?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Entitlements\Feature
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Entitlements/FeatureService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/FeatureService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/entitlements/active_entitlements', $params, $opts);
} | Retrieve a list of active entitlements for a customer.
@param null|array{customer: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Entitlements\ActiveEntitlement>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Entitlements/ActiveEntitlementService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/ActiveEntitlementService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/entitlements/active_entitlements/%s', $id), $params, $opts);
} | Retrieve an active entitlement.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Entitlements\ActiveEntitlement
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Entitlements/ActiveEntitlementService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Entitlements/ActiveEntitlementService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/disputes', $params, $opts);
} | Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted
in descending order by creation date, with the most recently created object
appearing first.
@param null|array{created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string, transaction?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Dispute>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/DisputeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/DisputeService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/issuing/disputes', $params, $opts);
} | Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence
within the <code>evidence</code> object are optional at this point. Stripe only
validates that required evidence is present during submission. Refer to <a
href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute
reasons and evidence</a> for more details about evidence requirements.
@param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: \Stripe\StripeObject, transaction?: string, treasury?: array{received_debit: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Dispute
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Issuing/DisputeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/DisputeService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/disputes/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Dispute</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Dispute
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/DisputeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/DisputeService.php | MIT |
public function submit($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/disputes/%s/submit', $id), $params, $opts);
} | Submits an Issuing <code>Dispute</code> to the card network. Stripe validates
that all evidence fields required for the dispute’s reason are present. For more
details, see <a
href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute
reasons and evidence</a>.
@param string $id
@param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Dispute
@throws \Stripe\Exception\ApiErrorException if the request fails | submit | php | stripe/stripe-php | lib/Service/Issuing/DisputeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/DisputeService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/disputes/%s', $id), $params, $opts);
} | Updates the specified Issuing <code>Dispute</code> object by setting the values
of the parameters passed. Any parameters not provided will be left unchanged.
Properties on the <code>evidence</code> object can be unset by passing in an
empty string.
@param string $id
@param null|array{amount?: int, evidence?: array{canceled?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_policy_provided?: null|bool, cancellation_reason?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string, return_status?: null|string, returned_at?: null|int}, duplicate?: null|array{additional_documentation?: null|string, card_statement?: null|string, cash_receipt?: null|string, check_image?: null|string, explanation?: null|string, original_transaction?: string}, fraudulent?: null|array{additional_documentation?: null|string, explanation?: null|string}, merchandise_not_as_described?: null|array{additional_documentation?: null|string, explanation?: null|string, received_at?: null|int, return_description?: null|string, return_status?: null|string, returned_at?: null|int}, no_valid_authorization?: null|array{additional_documentation?: null|string, explanation?: null|string}, not_received?: null|array{additional_documentation?: null|string, expected_at?: null|int, explanation?: null|string, product_description?: null|string, product_type?: null|string}, other?: null|array{additional_documentation?: null|string, explanation?: null|string, product_description?: null|string, product_type?: null|string}, reason?: string, service_not_as_described?: null|array{additional_documentation?: null|string, canceled_at?: null|int, cancellation_reason?: null|string, explanation?: null|string, received_at?: null|int}}, expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Dispute
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/DisputeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/DisputeService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/physical_bundles', $params, $opts);
} | Returns a list of physical bundle objects. The objects are sorted in descending
order by creation date, with the most recently created object appearing first.
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\PhysicalBundle>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/PhysicalBundleService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PhysicalBundleService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/physical_bundles/%s', $id), $params, $opts);
} | Retrieves a physical bundle object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PhysicalBundle
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/PhysicalBundleService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PhysicalBundleService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/cards', $params, $opts);
} | Returns a list of Issuing <code>Card</code> objects. The objects are sorted in
descending order by creation date, with the most recently created object
appearing first.
@param null|array{cardholder?: string, created?: array|int, ending_before?: string, exp_month?: int, exp_year?: int, expand?: string[], last4?: string, limit?: int, personalization_design?: string, starting_after?: string, status?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Card>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/issuing/cards', $params, $opts);
} | Creates an Issuing <code>Card</code> object.
@param null|array{cardholder?: string, currency: string, expand?: string[], financial_account?: string, metadata?: \Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, replacement_for?: string, replacement_reason?: string, second_line?: null|string, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string, type: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/cards/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Card</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/cards/%s', $id), $params, $opts);
} | Updates the specified Issuing <code>Card</code> object by setting the values of
the parameters passed. Any parameters not provided will be left unchanged.
@param string $id
@param null|array{cancellation_reason?: string, expand?: string[], metadata?: null|\Stripe\StripeObject, personalization_design?: string, pin?: array{encrypted_number?: string}, shipping?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}, address_validation?: array{mode: string}, customs?: array{eori_number?: string}, name: string, phone_number?: string, require_signature?: bool, service?: string, type?: string}, spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[]}, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Card
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/CardService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/cardholders', $params, $opts);
} | Returns a list of Issuing <code>Cardholder</code> objects. The objects are
sorted in descending order by creation date, with the most recently created
object appearing first.
@param null|array{created?: array|int, email?: string, ending_before?: string, expand?: string[], limit?: int, phone_number?: string, starting_after?: string, status?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Cardholder>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/CardholderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardholderService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/issuing/cardholders', $params, $opts);
} | Creates a new Issuing <code>Cardholder</code> object that can be issued cards.
@param null|array{billing: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: \Stripe\StripeObject, name: string, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Cardholder
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Issuing/CardholderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardholderService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Cardholder</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Cardholder
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/CardholderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardholderService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
} | Updates the specified Issuing <code>Cardholder</code> object by setting the
values of the parameters passed. Any parameters not provided will be left
unchanged.
@param string $id
@param null|array{billing?: array{address: array{city: string, country: string, line1: string, line2?: string, postal_code: string, state?: string}}, company?: array{tax_id?: string}, email?: string, expand?: string[], individual?: array{card_issuing?: array{user_terms_acceptance?: array{date?: int, ip?: string, user_agent?: null|string}}, dob?: array{day: int, month: int, year: int}, first_name?: string, last_name?: string, verification?: array{document?: array{back?: string, front?: string}}}, metadata?: \Stripe\StripeObject, phone_number?: string, preferred_locales?: string[], spending_controls?: array{allowed_categories?: string[], allowed_merchant_countries?: string[], blocked_categories?: string[], blocked_merchant_countries?: string[], spending_limits?: array{amount: int, categories?: string[], interval: string}[], spending_limits_currency?: string}, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Cardholder
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/CardholderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/CardholderService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/transactions', $params, $opts);
} | Returns a list of Issuing <code>Transaction</code> objects. The objects are
sorted in descending order by creation date, with the most recently created
object appearing first.
@param null|array{card?: string, cardholder?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Transaction>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/transactions/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Transaction</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TransactionService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/transactions/%s', $id), $params, $opts);
} | Updates the specified Issuing <code>Transaction</code> object by setting the
values of the parameters passed. Any parameters not provided will be left
unchanged.
@param string $id
@param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TransactionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/tokens', $params, $opts);
} | Lists all Issuing <code>Token</code> objects for a given card.
@param null|array{card: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Token>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/TokenService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TokenService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/tokens/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Token</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Token
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/TokenService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TokenService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/tokens/%s', $id), $params, $opts);
} | Attempts to update the specified Issuing <code>Token</code> object to the status
specified.
@param string $id
@param null|array{expand?: string[], status: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Token
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/TokenService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/TokenService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/authorizations', $params, $opts);
} | Returns a list of Issuing <code>Authorization</code> objects. The objects are
sorted in descending order by creation date, with the most recently created
object appearing first.
@param null|array{card?: string, cardholder?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\Authorization>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/AuthorizationService.php | MIT |
public function approve($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/authorizations/%s/approve', $id), $params, $opts);
} | [Deprecated] Approves a pending Issuing <code>Authorization</code> object. This
request should be made within the timeout window of the <a
href="/docs/issuing/controls/real-time-authorizations">real-time
authorization</a> flow. This method is deprecated. Instead, <a
href="/docs/issuing/controls/real-time-authorizations#authorization-handling">respond
directly to the webhook request to approve an authorization</a>.
@deprecated this method is deprecated, please refer to the description for details
@param string $id
@param null|array{amount?: int, expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | approve | php | stripe/stripe-php | lib/Service/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/AuthorizationService.php | MIT |
public function decline($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/authorizations/%s/decline', $id), $params, $opts);
} | [Deprecated] Declines a pending Issuing <code>Authorization</code> object. This
request should be made within the timeout window of the <a
href="/docs/issuing/controls/real-time-authorizations">real time
authorization</a> flow. This method is deprecated. Instead, <a
href="/docs/issuing/controls/real-time-authorizations#authorization-handling">respond
directly to the webhook request to decline an authorization</a>.
@deprecated this method is deprecated, please refer to the description for details
@param string $id
@param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | decline | php | stripe/stripe-php | lib/Service/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/AuthorizationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/authorizations/%s', $id), $params, $opts);
} | Retrieves an Issuing <code>Authorization</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/AuthorizationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/authorizations/%s', $id), $params, $opts);
} | Updates the specified Issuing <code>Authorization</code> object by setting the
values of the parameters passed. Any parameters not provided will be left
unchanged.
@param string $id
@param null|array{expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\Authorization
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/AuthorizationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/AuthorizationService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/issuing/personalization_designs', $params, $opts);
} | Returns a list of personalization design objects. The objects are sorted in
descending order by creation date, with the most recently created object
appearing first.
@param null|array{ending_before?: string, expand?: string[], limit?: int, lookup_keys?: string[], preferences?: array{is_default?: bool, is_platform_default?: bool}, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Issuing\PersonalizationDesign>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PersonalizationDesignService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/issuing/personalization_designs', $params, $opts);
} | Creates a personalization design object.
@param null|array{card_logo?: string, carrier_text?: array{footer_body?: null|string, footer_title?: null|string, header_body?: null|string, header_title?: null|string}, expand?: string[], lookup_key?: string, metadata?: \Stripe\StripeObject, name?: string, physical_bundle: string, preferences?: array{is_default: bool}, transfer_lookup_key?: bool} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PersonalizationDesignService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/issuing/personalization_designs/%s', $id), $params, $opts);
} | Retrieves a personalization design object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PersonalizationDesignService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/issuing/personalization_designs/%s', $id), $params, $opts);
} | Updates a card personalization object.
@param string $id
@param null|array{card_logo?: null|string, carrier_text?: null|array{footer_body?: null|string, footer_title?: null|string, header_body?: null|string, header_title?: null|string}, expand?: string[], lookup_key?: null|string, metadata?: \Stripe\StripeObject, name?: null|string, physical_bundle?: string, preferences?: array{is_default: bool}, transfer_lookup_key?: bool} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Issuing\PersonalizationDesign
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Issuing/PersonalizationDesignService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Issuing/PersonalizationDesignService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/sigma/scheduled_query_runs', $params, $opts);
} | Returns a list of scheduled query runs.
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Sigma\ScheduledQueryRun>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Sigma/ScheduledQueryRunService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Sigma/ScheduledQueryRunService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/sigma/scheduled_query_runs/%s', $id), $params, $opts);
} | Retrieves the details of an scheduled query run.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Sigma\ScheduledQueryRun
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Sigma/ScheduledQueryRunService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Sigma/ScheduledQueryRunService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/identity/verification_reports', $params, $opts);
} | List all verification reports.
@param null|array{client_reference_id?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, starting_after?: string, type?: string, verification_session?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Identity\VerificationReport>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Identity/VerificationReportService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationReportService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/identity/verification_reports/%s', $id), $params, $opts);
} | Retrieves an existing VerificationReport.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationReport
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Identity/VerificationReportService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationReportService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/identity/verification_sessions', $params, $opts);
} | Returns a list of VerificationSessions.
@param null|array{client_reference_id?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, related_customer?: string, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Identity\VerificationSession>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s/cancel', $id), $params, $opts);
} | A VerificationSession object can be canceled when it is in
<code>requires_input</code> <a
href="/docs/identity/how-sessions-work">status</a>.
Once canceled, future submission attempts are disabled. This cannot be undone.
<a href="/docs/identity/verification-sessions#cancel">Learn more</a>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationSession
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/identity/verification_sessions', $params, $opts);
} | Creates a VerificationSession object.
After the VerificationSession is created, display a verification modal using the
session <code>client_secret</code> or send your users to the session’s
<code>url</code>.
If your API key is in test mode, verification checks won’t actually process,
though everything else will occur as if in live mode.
Related guide: <a href="/docs/identity/verify-identity-documents">Verify your
users’ identity documents</a>
@param null|array{client_reference_id?: string, expand?: string[], metadata?: \Stripe\StripeObject, options?: array{document?: null|array{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}}, provided_details?: array{email?: string, phone?: string}, related_customer?: string, return_url?: string, type?: string, verification_flow?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationSession
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function redact($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s/redact', $id), $params, $opts);
} | Redact a VerificationSession to remove all collected information from Stripe.
This will redact the VerificationSession and all objects related to it,
including VerificationReports, Events, request logs, etc.
A VerificationSession object can be redacted when it is in
<code>requires_input</code> or <code>verified</code> <a
href="/docs/identity/how-sessions-work">status</a>. Redacting a
VerificationSession in <code>requires_action</code> state will automatically
cancel it.
The redaction process may take up to four days. When the redaction process is in
progress, the VerificationSession’s <code>redaction.status</code> field will be
set to <code>processing</code>; when the process is finished, it will change to
<code>redacted</code> and an <code>identity.verification_session.redacted</code>
event will be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe
API, but all the fields that contain personal data will be replaced by the
string <code>[redacted]</code> or a similar placeholder. The
<code>metadata</code> field will also be erased. Redacted objects cannot be
updated or used for any purpose.
<a href="/docs/identity/verification-sessions#redact">Learn more</a>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationSession
@throws \Stripe\Exception\ApiErrorException if the request fails | redact | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/identity/verification_sessions/%s', $id), $params, $opts);
} | Retrieves the details of a VerificationSession that was previously created.
When the session status is <code>requires_input</code>, you can use this method
to retrieve a valid <code>client_secret</code> or <code>url</code> to allow
re-submission.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationSession
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/identity/verification_sessions/%s', $id), $params, $opts);
} | Updates a VerificationSession object.
When the session status is <code>requires_input</code>, you can use this method
to update the verification check and options.
@param string $id
@param null|array{expand?: string[], metadata?: \Stripe\StripeObject, options?: array{document?: null|array{allowed_types?: string[], require_id_number?: bool, require_live_capture?: bool, require_matching_selfie?: bool}}, provided_details?: array{email?: string, phone?: string}, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Identity\VerificationSession
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Identity/VerificationSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Identity/VerificationSessionService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/financial_connections/sessions', $params, $opts);
} | To launch the Financial Connections authorization flow, create a
<code>Session</code>. The session’s <code>client_secret</code> can be used to
launch the flow using Stripe.js.
@param null|array{account_holder: array{account?: string, customer?: string, type: string}, expand?: string[], filters?: array{account_subcategories?: string[], countries?: string[]}, permissions: string[], prefetch?: string[], return_url?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/FinancialConnections/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/SessionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/financial_connections/sessions/%s', $id), $params, $opts);
} | Retrieves the details of a Financial Connections <code>Session</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\FinancialConnections\Session
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/FinancialConnections/SessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/SessionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/financial_connections/accounts', $params, $opts);
} | Returns a list of Financial Connections <code>Account</code> objects.
@param null|array{account_holder?: array{account?: string, customer?: string}, ending_before?: string, expand?: string[], limit?: int, session?: string, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\FinancialConnections\Account>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/FinancialConnections/AccountService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/FinancialConnections/AccountService.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.