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 update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts);
} | Updates the specified charge by setting the values of the parameters passed. Any
parameters not provided will be left unchanged.
@param string $id
@param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|\Stripe\StripeObject, receipt_email?: 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}, transfer_group?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Charge
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/ChargeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/ChargeService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/balance_transactions', $params, $opts);
} | Returns a list of transactions that have contributed to the Stripe account
balance (e.g., charges, transfers, and so forth). The transactions are returned
in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the
path <code>/v1/balance/history</code>.
@param null|array{created?: array|int, currency?: string, ending_before?: string, expand?: string[], limit?: int, payout?: string, source?: string, starting_after?: string, type?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\BalanceTransaction>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/BalanceTransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BalanceTransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/balance_transactions/%s', $id), $params, $opts);
} | Retrieves the balance transaction with the given ID.
Note that this endpoint previously used the path
<code>/v1/balance/history/:id</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\BalanceTransaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/BalanceTransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/BalanceTransactionService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/apps/secrets', $params, $opts);
} | List all secrets stored on the given scope.
@param null|array{ending_before?: string, expand?: string[], limit?: int, scope: array{type: string, user?: string}, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Apps\Secret>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Apps/SecretService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Apps/SecretService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/apps/secrets', $params, $opts);
} | Create or replace a secret in the secret store.
@param null|array{expand?: string[], expires_at?: int, name: string, payload: string, scope: array{type: string, user?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Apps\Secret
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Apps/SecretService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Apps/SecretService.php | MIT |
public function deleteWhere($params = null, $opts = null)
{
return $this->request('post', '/v1/apps/secrets/delete', $params, $opts);
} | Deletes a secret from the secret store by name and scope.
@param null|array{expand?: string[], name: string, scope: array{type: string, user?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Apps\Secret
@throws \Stripe\Exception\ApiErrorException if the request fails | deleteWhere | php | stripe/stripe-php | lib/Service/Apps/SecretService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Apps/SecretService.php | MIT |
public function find($params = null, $opts = null)
{
return $this->request('get', '/v1/apps/secrets/find', $params, $opts);
} | Finds a secret in the secret store by name and scope.
@param null|array{expand?: string[], name: string, scope: array{type: string, user?: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Apps\Secret
@throws \Stripe\Exception\ApiErrorException if the request fails | find | php | stripe/stripe-php | lib/Service/Apps/SecretService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Apps/SecretService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/terminal/locations', $params, $opts);
} | Returns a list of <code>Location</code> objects.
@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\Terminal\Location>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Terminal/LocationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/LocationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/terminal/locations', $params, $opts);
} | Creates a new <code>Location</code> object. For further details, including which
address fields are required in each country, see the <a
href="/docs/terminal/fleet/locations">Manage locations</a> guide.
@param null|array{address: array{city?: string, country: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: string, display_name: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Location
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Terminal/LocationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/LocationService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
} | Deletes a <code>Location</code> object.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Location
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/Terminal/LocationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/LocationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
} | Retrieves a <code>Location</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Location
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Terminal/LocationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/LocationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
} | Updates a <code>Location</code> object by setting the values of the parameters
passed. Any parameters not provided will be left unchanged.
@param string $id
@param null|array{address?: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, configuration_overrides?: null|string, display_name?: string, expand?: string[], metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Location
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Terminal/LocationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/LocationService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/terminal/readers', $params, $opts);
} | Returns a list of <code>Reader</code> objects.
@param null|array{device_type?: string, ending_before?: string, expand?: string[], limit?: int, location?: string, serial_number?: string, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Terminal\Reader>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function cancelAction($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/cancel_action', $id), $params, $opts);
} | Cancels the current reader action.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | cancelAction | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/terminal/readers', $params, $opts);
} | Creates a new <code>Reader</code> object.
@param null|array{expand?: string[], label?: string, location?: string, metadata?: null|\Stripe\StripeObject, registration_code: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
} | Deletes a <code>Reader</code> object.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function processPaymentIntent($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/process_payment_intent', $id), $params, $opts);
} | Initiates a payment flow on a Reader.
@param string $id
@param null|array{expand?: string[], payment_intent: string, process_config?: array{allow_redisplay?: string, enable_customer_cancellation?: bool, skip_tipping?: bool, tipping?: array{amount_eligible?: int}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | processPaymentIntent | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function processSetupIntent($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/process_setup_intent', $id), $params, $opts);
} | Initiates a setup intent flow on a Reader.
@param string $id
@param null|array{allow_redisplay: string, expand?: string[], process_config?: array{enable_customer_cancellation?: bool}, setup_intent: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | processSetupIntent | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function refundPayment($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/refund_payment', $id), $params, $opts);
} | Initiates a refund on a Reader.
@param string $id
@param null|array{amount?: int, charge?: string, expand?: string[], metadata?: \Stripe\StripeObject, payment_intent?: string, refund_application_fee?: bool, refund_payment_config?: array{enable_customer_cancellation?: bool}, reverse_transfer?: bool} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | refundPayment | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
} | Retrieves a <code>Reader</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function setReaderDisplay($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s/set_reader_display', $id), $params, $opts);
} | Sets reader display to show cart details.
@param string $id
@param null|array{cart?: array{currency: string, line_items: array{amount: int, description: string, quantity: int}[], tax?: int, total: int}, expand?: string[], type: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | setReaderDisplay | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
} | Updates a <code>Reader</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[], label?: null|string, metadata?: null|\Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Reader
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Terminal/ReaderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ReaderService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/terminal/configurations', $params, $opts);
} | Returns a list of <code>Configuration</code> objects.
@param null|array{ending_before?: string, expand?: string[], is_account_default?: bool, limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Terminal\Configuration>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Terminal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConfigurationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/terminal/configurations', $params, $opts);
} | Creates a new <code>Configuration</code> object.
@param null|array{bbpos_wisepos_e?: array{splashscreen?: null|string}, expand?: string[], name?: string, offline?: null|array{enabled: bool}, reboot_window?: array{end_hour: int, start_hour: int}, stripe_s700?: array{splashscreen?: null|string}, tipping?: null|array{aud?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, cad?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, chf?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, czk?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, dkk?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, eur?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, gbp?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, hkd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, jpy?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, myr?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, nok?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, nzd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, pln?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, sek?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, sgd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, usd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}}, verifone_p400?: array{splashscreen?: null|string}, wifi?: null|array{enterprise_eap_peap?: array{ca_certificate_file?: string, password: string, ssid: string, username: string}, enterprise_eap_tls?: array{ca_certificate_file?: string, client_certificate_file: string, private_key_file: string, private_key_file_password?: string, ssid: string}, personal_psk?: array{password: string, ssid: string}, type: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Terminal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConfigurationService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/terminal/configurations/%s', $id), $params, $opts);
} | Deletes a <code>Configuration</code> object.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/Terminal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConfigurationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/terminal/configurations/%s', $id), $params, $opts);
} | Retrieves a <code>Configuration</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Terminal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConfigurationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/terminal/configurations/%s', $id), $params, $opts);
} | Updates a new <code>Configuration</code> object.
@param string $id
@param null|array{bbpos_wisepos_e?: null|array{splashscreen?: null|string}, expand?: string[], name?: string, offline?: null|array{enabled: bool}, reboot_window?: null|array{end_hour: int, start_hour: int}, stripe_s700?: null|array{splashscreen?: null|string}, tipping?: null|array{aud?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, cad?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, chf?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, czk?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, dkk?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, eur?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, gbp?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, hkd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, jpy?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, myr?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, nok?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, nzd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, pln?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, sek?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, sgd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}, usd?: array{fixed_amounts?: int[], percentages?: int[], smart_tip_threshold?: int}}, verifone_p400?: null|array{splashscreen?: null|string}, wifi?: null|array{enterprise_eap_peap?: array{ca_certificate_file?: string, password: string, ssid: string, username: string}, enterprise_eap_tls?: array{ca_certificate_file?: string, client_certificate_file: string, private_key_file: string, private_key_file_password?: string, ssid: string}, personal_psk?: array{password: string, ssid: string}, type: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\Configuration
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Terminal/ConfigurationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConfigurationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/terminal/connection_tokens', $params, $opts);
} | To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived
connection token from Stripe, proxied through your server. On your backend, add
an endpoint that creates and returns a connection token.
@param null|array{expand?: string[], location?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Terminal\ConnectionToken
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Terminal/ConnectionTokenService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Terminal/ConnectionTokenService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/climate/orders', $params, $opts);
} | Lists all Climate order objects. The orders are returned sorted by creation
date, with the most recently created orders appearing first.
@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\Climate\Order>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Climate/OrderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/OrderService.php | MIT |
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/climate/orders/%s/cancel', $id), $params, $opts);
} | Cancels a Climate order. You can cancel an order within 24 hours of creation.
Stripe refunds the reservation <code>amount_subtotal</code>, but not the
<code>amount_fees</code> for user-triggered cancellations. Frontier might cancel
reservations if suppliers fail to deliver. If Frontier cancels the reservation,
Stripe provides 90 days advance notice and refunds the
<code>amount_total</code>.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Order
@throws \Stripe\Exception\ApiErrorException if the request fails | cancel | php | stripe/stripe-php | lib/Service/Climate/OrderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/OrderService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/climate/orders', $params, $opts);
} | Creates a Climate order object for a given Climate product. The order will be
processed immediately after creation and payment will be deducted your Stripe
balance.
@param null|array{amount?: int, beneficiary?: array{public_name: string}, currency?: string, expand?: string[], metadata?: \Stripe\StripeObject, metric_tons?: string, product: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Order
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Climate/OrderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/OrderService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/climate/orders/%s', $id), $params, $opts);
} | Retrieves the details of a Climate order object with the given ID.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Order
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Climate/OrderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/OrderService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/climate/orders/%s', $id), $params, $opts);
} | Updates the specified order by setting the values of the parameters passed.
@param string $id
@param null|array{beneficiary?: null|array{public_name: null|string}, expand?: string[], metadata?: \Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Order
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Climate/OrderService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/OrderService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/climate/suppliers', $params, $opts);
} | Lists all available Climate supplier objects.
@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\Climate\Supplier>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Climate/SupplierService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/SupplierService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/climate/suppliers/%s', $id), $params, $opts);
} | Retrieves a Climate supplier object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Supplier
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Climate/SupplierService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/SupplierService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/climate/products', $params, $opts);
} | Lists all available Climate product objects.
@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\Climate\Product>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Climate/ProductService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/ProductService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/climate/products/%s', $id), $params, $opts);
} | Retrieves the details of a Climate product with the given ID.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Climate\Product
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Climate/ProductService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Climate/ProductService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/billing/credit_balance_transactions', $params, $opts);
} | Retrieve a list of credit balance transactions.
@param null|array{credit_grant?: string, customer: string, ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Billing\CreditBalanceTransaction>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Billing/CreditBalanceTransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditBalanceTransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/billing/credit_balance_transactions/%s', $id), $params, $opts);
} | Retrieves a credit balance transaction.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditBalanceTransaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Billing/CreditBalanceTransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditBalanceTransactionService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing/meter_event_adjustments', $params, $opts);
} | Creates a billing meter event adjustment.
@param null|array{cancel?: array{identifier?: string}, event_name: string, expand?: string[], type: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\MeterEventAdjustment
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Billing/MeterEventAdjustmentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterEventAdjustmentService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/billing/credit_grants', $params, $opts);
} | Retrieve a list of credit grants.
@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\Billing\CreditGrant>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing/credit_grants', $params, $opts);
} | Creates a credit grant.
@param null|array{amount: array{monetary?: array{currency: string, value: int}, type: string}, applicability_config: array{scope: array{price_type?: string, prices?: array{id: string}[]}}, category: string, customer: string, effective_at?: int, expand?: string[], expires_at?: int, metadata?: \Stripe\StripeObject, name?: string, priority?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditGrant
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function expire($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/credit_grants/%s/expire', $id), $params, $opts);
} | Expires a credit grant.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditGrant
@throws \Stripe\Exception\ApiErrorException if the request fails | expire | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/billing/credit_grants/%s', $id), $params, $opts);
} | Retrieves a credit grant.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditGrant
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/credit_grants/%s', $id), $params, $opts);
} | Updates a credit grant.
@param string $id
@param null|array{expand?: string[], expires_at?: null|int, metadata?: \Stripe\StripeObject} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditGrant
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function voidGrant($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/credit_grants/%s/void', $id), $params, $opts);
} | Voids a credit grant.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditGrant
@throws \Stripe\Exception\ApiErrorException if the request fails | voidGrant | php | stripe/stripe-php | lib/Service/Billing/CreditGrantService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditGrantService.php | MIT |
public function retrieve($params = null, $opts = null)
{
return $this->request('get', '/v1/billing/credit_balance_summary', $params, $opts);
} | Retrieves the credit balance summary for a customer.
@param null|array{customer: string, expand?: string[], filter: array{applicability_scope?: array{price_type?: string, prices?: array{id: string}[]}, credit_grant?: string, type: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\CreditBalanceSummary
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Billing/CreditBalanceSummaryService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/CreditBalanceSummaryService.php | MIT |
public function activate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/alerts/%s/activate', $id), $params, $opts);
} | Reactivates this alert, allowing it to trigger again.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Alert
@throws \Stripe\Exception\ApiErrorException if the request fails | activate | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/billing/alerts', $params, $opts);
} | Lists billing active and inactive alerts.
@param null|array{alert_type?: string, ending_before?: string, expand?: string[], limit?: int, meter?: string, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Billing\Alert>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function archive($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/alerts/%s/archive', $id), $params, $opts);
} | Archives this alert, removing it from the list view and APIs. This is
non-reversible.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Alert
@throws \Stripe\Exception\ApiErrorException if the request fails | archive | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing/alerts', $params, $opts);
} | Creates a billing alert.
@param null|array{alert_type: string, expand?: string[], title: string, usage_threshold?: array{filters?: array{customer?: string, type: string}[], gte: int, meter?: string, recurrence: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Alert
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function deactivate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/alerts/%s/deactivate', $id), $params, $opts);
} | Deactivates this alert, preventing it from triggering.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Alert
@throws \Stripe\Exception\ApiErrorException if the request fails | deactivate | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/billing/alerts/%s', $id), $params, $opts);
} | Retrieves a billing alert given an ID.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Alert
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Billing/AlertService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/AlertService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/billing/meters', $params, $opts);
} | Retrieve a list of billing meters.
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Billing\Meter>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function allEventSummaries($parentId, $params = null, $opts = null)
{
return $this->requestCollection('get', $this->buildPath('/v1/billing/meters/%s/event_summaries', $parentId), $params, $opts);
} | Retrieve a list of billing meter event summaries.
@param string $parentId
@param null|array{customer: string, end_time: int, ending_before?: string, expand?: string[], limit?: int, start_time: int, starting_after?: string, value_grouping_window?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Billing\MeterEventSummary>
@throws \Stripe\Exception\ApiErrorException if the request fails | allEventSummaries | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing/meters', $params, $opts);
} | Creates a billing meter.
@param null|array{customer_mapping?: array{event_payload_key: string, type: string}, default_aggregation: array{formula: string}, display_name: string, event_name: string, event_time_window?: string, expand?: string[], value_settings?: array{event_payload_key: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Meter
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function deactivate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/meters/%s/deactivate', $id), $params, $opts);
} | When a meter is deactivated, no more meter events will be accepted for this
meter. You can’t attach a deactivated meter to a price.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Meter
@throws \Stripe\Exception\ApiErrorException if the request fails | deactivate | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function reactivate($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/meters/%s/reactivate', $id), $params, $opts);
} | When a meter is reactivated, events for this meter can be accepted and you can
attach the meter to a price.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Meter
@throws \Stripe\Exception\ApiErrorException if the request fails | reactivate | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/billing/meters/%s', $id), $params, $opts);
} | Retrieves a billing meter given an ID.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Meter
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/billing/meters/%s', $id), $params, $opts);
} | Updates a billing meter.
@param string $id
@param null|array{display_name?: string, expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\Meter
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Billing/MeterService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/billing/meter_events', $params, $opts);
} | Creates a billing meter event.
@param null|array{event_name: string, expand?: string[], identifier?: string, payload: \Stripe\StripeObject, timestamp?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Billing\MeterEvent
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Billing/MeterEventService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Billing/MeterEventService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/radar/value_list_items', $params, $opts);
} | Returns a list of <code>ValueListItem</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, value?: string, value_list: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Radar\ValueListItem>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Radar/ValueListItemService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListItemService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/radar/value_list_items', $params, $opts);
} | Creates a new <code>ValueListItem</code> object, which is added to the specified
parent value list.
@param null|array{expand?: string[], value: string, value_list: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueListItem
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Radar/ValueListItemService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListItemService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/radar/value_list_items/%s', $id), $params, $opts);
} | Deletes a <code>ValueListItem</code> object, removing it from its parent value
list.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueListItem
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/Radar/ValueListItemService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListItemService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/radar/value_list_items/%s', $id), $params, $opts);
} | Retrieves a <code>ValueListItem</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueListItem
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Radar/ValueListItemService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListItemService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/radar/early_fraud_warnings', $params, $opts);
} | Returns a list of early fraud warnings.
@param null|array{charge?: string, created?: array|int, ending_before?: string, expand?: string[], limit?: int, payment_intent?: string, starting_after?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Radar\EarlyFraudWarning>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Radar/EarlyFraudWarningService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/EarlyFraudWarningService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/radar/early_fraud_warnings/%s', $id), $params, $opts);
} | Retrieves the details of an early fraud warning that has previously been
created.
Please refer to the <a href="#early_fraud_warning_object">early fraud
warning</a> object reference for more details.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\EarlyFraudWarning
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Radar/EarlyFraudWarningService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/EarlyFraudWarningService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/radar/value_lists', $params, $opts);
} | Returns a list of <code>ValueList</code> objects. The objects are sorted in
descending order by creation date, with the most recently created object
appearing first.
@param null|array{alias?: string, contains?: string, 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\Radar\ValueList>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Radar/ValueListService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/radar/value_lists', $params, $opts);
} | Creates a new <code>ValueList</code> object, which can then be referenced in
rules.
@param null|array{alias: string, expand?: string[], item_type?: string, metadata?: \Stripe\StripeObject, name: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueList
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Radar/ValueListService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
} | Deletes a <code>ValueList</code> object, also deleting any items contained
within the value list. To be deleted, a value list must not be referenced in any
rules.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueList
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/Radar/ValueListService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
} | Retrieves a <code>ValueList</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueList
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Radar/ValueListService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
} | Updates a <code>ValueList</code> object by setting the values of the parameters
passed. Any parameters not provided will be left unchanged. Note that
<code>item_type</code> is immutable.
@param string $id
@param null|array{alias?: string, expand?: string[], metadata?: \Stripe\StripeObject, name?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Radar\ValueList
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Radar/ValueListService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Radar/ValueListService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v2/billing/meter_event_adjustments', $params, $opts);
} | Creates a meter event adjustment to cancel a previously sent meter event.
@param null|array{cancel: array{identifier: string}, event_name: string, type: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Billing\MeterEventAdjustment
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/V2/Billing/MeterEventAdjustmentService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Billing/MeterEventAdjustmentService.php | MIT |
public function create($params = null, $opts = null)
{
$opts = \Stripe\Util\RequestOptions::parse($opts);
if (!isset($opts->apiBase)) {
$opts->apiBase = $this->getClient()->getMeterEventsBase();
}
$this->request('post', '/v2/billing/meter_event_stream', $params, $opts);
} | Creates meter events. Events are processed asynchronously, including validation.
Requires a meter event session for authentication. Supports up to 10,000
requests per second in livemode. For even higher rate-limits, contact sales.
@param null|array{events: array{event_name: string, identifier?: string, payload: \Stripe\StripeObject, timestamp?: string}[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return void
@throws \Stripe\Exception\TemporarySessionExpiredException | create | php | stripe/stripe-php | lib/Service/V2/Billing/MeterEventStreamService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Billing/MeterEventStreamService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v2/billing/meter_event_session', $params, $opts);
} | Creates a meter event session to send usage on the high-throughput meter event
stream. Authentication tokens are only valid for 15 minutes, so you will need to
create a new meter event session when your token expires.
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Billing\MeterEventSession
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/V2/Billing/MeterEventSessionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Billing/MeterEventSessionService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v2/billing/meter_events', $params, $opts);
} | Creates a meter event. Events are validated synchronously, but are processed
asynchronously. Supports up to 1,000 events per second in livemode. For higher
rate-limits, please use meter event streams instead.
@param null|array{event_name: string, identifier?: string, payload: \Stripe\StripeObject, timestamp?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Billing\MeterEvent
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/V2/Billing/MeterEventService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Billing/MeterEventService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v2/core/events', $params, $opts);
} | List events, going back up to 30 days.
@param null|array{limit?: int, object_id: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Collection<\Stripe\V2\Event>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/V2/Core/EventService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v2/core/events/%s', $id), $params, $opts);
} | Retrieves the details of an event.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Event
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/V2/Core/EventService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v2/core/event_destinations', $params, $opts);
} | Lists all event destinations.
@param null|array{include?: string[], limit?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Collection<\Stripe\V2\EventDestination>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v2/core/event_destinations', $params, $opts);
} | Create a new event destination.
@param null|array{description?: string, enabled_events: string[], event_payload: string, events_from?: string[], include?: string[], metadata?: \Stripe\StripeObject, name: string, snapshot_api_version?: string, type: string, amazon_eventbridge?: array{aws_account_id: string, aws_region: string}, webhook_endpoint?: array{url: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function delete($id, $params = null, $opts = null)
{
return $this->request('delete', $this->buildPath('/v2/core/event_destinations/%s', $id), $params, $opts);
} | Delete an event destination.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | delete | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function disable($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v2/core/event_destinations/%s/disable', $id), $params, $opts);
} | Disable an event destination.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | disable | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function enable($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v2/core/event_destinations/%s/enable', $id), $params, $opts);
} | Enable an event destination.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | enable | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function ping($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v2/core/event_destinations/%s/ping', $id), $params, $opts);
} | Send a `ping` event to an event destination.
@param string $id
@param null|array $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\Event
@throws \Stripe\Exception\ApiErrorException if the request fails | ping | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v2/core/event_destinations/%s', $id), $params, $opts);
} | Retrieves the details of an event destination.
@param string $id
@param null|array{include?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v2/core/event_destinations/%s', $id), $params, $opts);
} | Update the details of an event destination.
@param string $id
@param null|array{description?: string, enabled_events?: string[], include?: string[], metadata?: \Stripe\StripeObject, name?: string, webhook_endpoint?: array{url: string}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\V2\EventDestination
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/V2/Core/EventDestinationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/V2/Core/EventDestinationService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/tax/registrations', $params, $opts);
} | Returns a list of Tax <code>Registration</code> objects.
@param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Tax\Registration>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Tax/RegistrationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/RegistrationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/tax/registrations', $params, $opts);
} | Creates a new Tax <code>Registration</code> object.
@param null|array{active_from: array|int|string, country: string, country_options: array{ae?: array{type: string}, al?: array{type: string}, am?: array{type: string}, ao?: array{type: string}, at?: array{standard?: array{place_of_supply_scheme: string}, type: string}, au?: array{type: string}, aw?: array{type: string}, az?: array{type: string}, ba?: array{type: string}, bb?: array{type: string}, bd?: array{type: string}, be?: array{standard?: array{place_of_supply_scheme: string}, type: string}, bf?: array{type: string}, bg?: array{standard?: array{place_of_supply_scheme: string}, type: string}, bh?: array{type: string}, bj?: array{type: string}, bs?: array{type: string}, by?: array{type: string}, ca?: array{province_standard?: array{province: string}, type: string}, cd?: array{type: string}, ch?: array{type: string}, cl?: array{type: string}, cm?: array{type: string}, co?: array{type: string}, cr?: array{type: string}, cv?: array{type: string}, cy?: array{standard?: array{place_of_supply_scheme: string}, type: string}, cz?: array{standard?: array{place_of_supply_scheme: string}, type: string}, de?: array{standard?: array{place_of_supply_scheme: string}, type: string}, dk?: array{standard?: array{place_of_supply_scheme: string}, type: string}, ec?: array{type: string}, ee?: array{standard?: array{place_of_supply_scheme: string}, type: string}, eg?: array{type: string}, es?: array{standard?: array{place_of_supply_scheme: string}, type: string}, et?: array{type: string}, fi?: array{standard?: array{place_of_supply_scheme: string}, type: string}, fr?: array{standard?: array{place_of_supply_scheme: string}, type: string}, gb?: array{type: string}, ge?: array{type: string}, gn?: array{type: string}, gr?: array{standard?: array{place_of_supply_scheme: string}, type: string}, hr?: array{standard?: array{place_of_supply_scheme: string}, type: string}, hu?: array{standard?: array{place_of_supply_scheme: string}, type: string}, id?: array{type: string}, ie?: array{standard?: array{place_of_supply_scheme: string}, type: string}, in?: array{type: string}, is?: array{type: string}, it?: array{standard?: array{place_of_supply_scheme: string}, type: string}, jp?: array{type: string}, ke?: array{type: string}, kg?: array{type: string}, kh?: array{type: string}, kr?: array{type: string}, kz?: array{type: string}, la?: array{type: string}, lt?: array{standard?: array{place_of_supply_scheme: string}, type: string}, lu?: array{standard?: array{place_of_supply_scheme: string}, type: string}, lv?: array{standard?: array{place_of_supply_scheme: string}, type: string}, ma?: array{type: string}, md?: array{type: string}, me?: array{type: string}, mk?: array{type: string}, mr?: array{type: string}, mt?: array{standard?: array{place_of_supply_scheme: string}, type: string}, mx?: array{type: string}, my?: array{type: string}, ng?: array{type: string}, nl?: array{standard?: array{place_of_supply_scheme: string}, type: string}, no?: array{type: string}, np?: array{type: string}, nz?: array{type: string}, om?: array{type: string}, pe?: array{type: string}, ph?: array{type: string}, pl?: array{standard?: array{place_of_supply_scheme: string}, type: string}, pt?: array{standard?: array{place_of_supply_scheme: string}, type: string}, ro?: array{standard?: array{place_of_supply_scheme: string}, type: string}, rs?: array{type: string}, ru?: array{type: string}, sa?: array{type: string}, se?: array{standard?: array{place_of_supply_scheme: string}, type: string}, sg?: array{type: string}, si?: array{standard?: array{place_of_supply_scheme: string}, type: string}, sk?: array{standard?: array{place_of_supply_scheme: string}, type: string}, sn?: array{type: string}, sr?: array{type: string}, th?: array{type: string}, tj?: array{type: string}, tr?: array{type: string}, tz?: array{type: string}, ug?: array{type: string}, us?: array{local_amusement_tax?: array{jurisdiction: string}, local_lease_tax?: array{jurisdiction: string}, state: string, state_sales_tax?: array{elections: array{jurisdiction?: string, type: string}[]}, type: string}, uy?: array{type: string}, uz?: array{type: string}, vn?: array{type: string}, za?: array{type: string}, zm?: array{type: string}, zw?: array{type: string}}, expand?: string[], expires_at?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Registration
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Tax/RegistrationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/RegistrationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/tax/registrations/%s', $id), $params, $opts);
} | Returns a Tax <code>Registration</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Registration
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Tax/RegistrationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/RegistrationService.php | MIT |
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/tax/registrations/%s', $id), $params, $opts);
} | Updates an existing Tax <code>Registration</code> object.
A registration cannot be deleted after it has been created. If you wish to end a
registration you may do so by setting <code>expires_at</code>.
@param string $id
@param null|array{active_from?: array|int|string, expand?: string[], expires_at?: null|array|int|string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Registration
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Tax/RegistrationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/RegistrationService.php | MIT |
public function retrieve($params = null, $opts = null)
{
return $this->request('get', '/v1/tax/settings', $params, $opts);
} | Retrieves Tax <code>Settings</code> for a merchant.
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Settings
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Tax/SettingsService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/SettingsService.php | MIT |
public function update($params = null, $opts = null)
{
return $this->request('post', '/v1/tax/settings', $params, $opts);
} | Updates Tax <code>Settings</code> parameters used in tax calculations. All
parameters are editable but none can be removed once set.
@param null|array{defaults?: array{tax_behavior?: string, tax_code?: string}, expand?: string[], head_office?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Settings
@throws \Stripe\Exception\ApiErrorException if the request fails | update | php | stripe/stripe-php | lib/Service/Tax/SettingsService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/SettingsService.php | MIT |
public function allLineItems($id, $params = null, $opts = null)
{
return $this->requestCollection('get', $this->buildPath('/v1/tax/transactions/%s/line_items', $id), $params, $opts);
} | Retrieves the line items of a committed standalone transaction as a collection.
@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\Tax\TransactionLineItem>
@throws \Stripe\Exception\ApiErrorException if the request fails | allLineItems | php | stripe/stripe-php | lib/Service/Tax/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/TransactionService.php | MIT |
public function createFromCalculation($params = null, $opts = null)
{
return $this->request('post', '/v1/tax/transactions/create_from_calculation', $params, $opts);
} | Creates a Tax Transaction from a calculation, if that calculation hasn’t
expired. Calculations expire after 90 days.
@param null|array{calculation: string, expand?: string[], metadata?: \Stripe\StripeObject, posted_at?: int, reference: string} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | createFromCalculation | php | stripe/stripe-php | lib/Service/Tax/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/TransactionService.php | MIT |
public function createReversal($params = null, $opts = null)
{
return $this->request('post', '/v1/tax/transactions/create_reversal', $params, $opts);
} | Partially or fully reverses a previously created <code>Transaction</code>.
@param null|array{expand?: string[], flat_amount?: int, line_items?: array{amount: int, amount_tax: int, metadata?: \Stripe\StripeObject, original_line_item: string, quantity?: int, reference: string}[], metadata?: \Stripe\StripeObject, mode: string, original_transaction: string, reference: string, shipping_cost?: array{amount: int, amount_tax: int}} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | createReversal | php | stripe/stripe-php | lib/Service/Tax/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/TransactionService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/tax/transactions/%s', $id), $params, $opts);
} | Retrieves a Tax <code>Transaction</code> object.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Transaction
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Tax/TransactionService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/TransactionService.php | MIT |
public function allLineItems($id, $params = null, $opts = null)
{
return $this->requestCollection('get', $this->buildPath('/v1/tax/calculations/%s/line_items', $id), $params, $opts);
} | Retrieves the line items of a tax calculation as a collection, if the
calculation hasn’t expired.
@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\Tax\CalculationLineItem>
@throws \Stripe\Exception\ApiErrorException if the request fails | allLineItems | php | stripe/stripe-php | lib/Service/Tax/CalculationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/CalculationService.php | MIT |
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/tax/calculations', $params, $opts);
} | Calculates tax based on the input and returns a Tax <code>Calculation</code>
object.
@param null|array{currency: string, customer?: string, customer_details?: array{address?: array{city?: null|string, country: string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}, address_source?: string, ip_address?: string, tax_ids?: array{type: string, value: string}[], taxability_override?: string}, expand?: string[], line_items: array{amount: int, product?: string, quantity?: int, reference?: string, tax_behavior?: string, tax_code?: string}[], ship_from_details?: array{address: array{city?: null|string, country: string, line1?: null|string, line2?: null|string, postal_code?: null|string, state?: null|string}}, shipping_cost?: array{amount?: int, shipping_rate?: string, tax_behavior?: string, tax_code?: string}, tax_date?: int} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Calculation
@throws \Stripe\Exception\ApiErrorException if the request fails | create | php | stripe/stripe-php | lib/Service/Tax/CalculationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/CalculationService.php | MIT |
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/tax/calculations/%s', $id), $params, $opts);
} | Retrieves a Tax <code>Calculation</code> object, if the calculation hasn’t
expired.
@param string $id
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Tax\Calculation
@throws \Stripe\Exception\ApiErrorException if the request fails | retrieve | php | stripe/stripe-php | lib/Service/Tax/CalculationService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Tax/CalculationService.php | MIT |
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/reporting/report_types', $params, $opts);
} | Returns a full list of Report Types.
@param null|array{expand?: string[]} $params
@param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
@return \Stripe\Collection<\Stripe\Reporting\ReportType>
@throws \Stripe\Exception\ApiErrorException if the request fails | all | php | stripe/stripe-php | lib/Service/Reporting/ReportTypeService.php | https://github.com/stripe/stripe-php/blob/master/lib/Service/Reporting/ReportTypeService.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.