├── VERSION
├── .coveralls.github-actions.yml
├── lib
    ├── Exception
    │   ├── BadMethodCallException.php
    │   ├── InvalidArgumentException.php
    │   ├── UnexpectedValueException.php
    │   ├── OAuth
    │   │   ├── ExceptionInterface.php
    │   │   ├── InvalidScopeException.php
    │   │   ├── UnsupportedGrantTypeException.php
    │   │   ├── InvalidRequestException.php
    │   │   ├── UnsupportedResponseTypeException.php
    │   │   ├── InvalidClientException.php
    │   │   ├── UnknownOAuthErrorException.php
    │   │   ├── InvalidGrantException.php
    │   │   └── OAuthErrorException.php
    │   ├── IdempotencyException.php
    │   ├── PermissionException.php
    │   ├── AuthenticationException.php
    │   ├── ApiConnectionException.php
    │   ├── RateLimitException.php
    │   ├── UnknownApiErrorException.php
    │   ├── ExceptionInterface.php
    │   ├── InvalidRequestException.php
    │   ├── SignatureVerificationException.php
    │   └── CardException.php
    ├── Discount.php
    ├── OrderItem.php
    ├── LoginLink.php
    ├── Issuing
    │   ├── CardDetails.php
    │   ├── Dispute.php
    │   ├── Cardholder.php
    │   └── Transaction.php
    ├── SourceTransaction.php
    ├── Service
    │   ├── Checkout
    │   │   ├── CheckoutServiceFactory.php
    │   │   └── SessionService.php
    │   ├── MandateService.php
    │   ├── BillingPortal
    │   │   ├── SessionService.php
    │   │   └── BillingPortalServiceFactory.php
    │   ├── Sigma
    │   │   ├── SigmaServiceFactory.php
    │   │   └── ScheduledQueryRunService.php
    │   ├── Reporting
    │   │   ├── ReportingServiceFactory.php
    │   │   ├── ReportTypeService.php
    │   │   └── ReportRunService.php
    │   ├── AccountLinkService.php
    │   ├── BalanceService.php
    │   ├── Terminal
    │   │   ├── TerminalServiceFactory.php
    │   │   ├── ConnectionTokenService.php
    │   │   ├── ReaderService.php
    │   │   └── LocationService.php
    │   ├── Radar
    │   │   ├── RadarServiceFactory.php
    │   │   ├── EarlyFraudWarningService.php
    │   │   ├── ValueListItemService.php
    │   │   └── ValueListService.php
    │   ├── Issuing
    │   │   ├── IssuingServiceFactory.php
    │   │   ├── TransactionService.php
    │   │   ├── CardService.php
    │   │   ├── DisputeService.php
    │   │   └── CardholderService.php
    │   ├── CountrySpecService.php
    │   ├── ExchangeRateService.php
    │   ├── TokenService.php
    │   ├── EphemeralKeyService.php
    │   ├── OrderReturnService.php
    │   ├── EventService.php
    │   ├── BalanceTransactionService.php
    │   ├── AbstractServiceFactory.php
    │   ├── ReviewService.php
    │   ├── ApplePayDomainService.php
    │   ├── FileLinkService.php
    │   ├── TaxRateService.php
    │   ├── FileService.php
    │   ├── PriceService.php
    │   ├── AbstractService.php
    │   ├── RefundService.php
    │   ├── TopupService.php
    │   ├── PlanService.php
    │   ├── DisputeService.php
    │   ├── ProductService.php
    │   ├── InvoiceItemService.php
    │   └── SkuService.php
    ├── RequestTelemetry.php
    ├── Terminal
    │   ├── ConnectionToken.php
    │   ├── Location.php
    │   └── Reader.php
    ├── UsageRecordSummary.php
    ├── ApiOperations
    │   ├── Delete.php
    │   ├── Retrieve.php
    │   ├── Create.php
    │   ├── All.php
    │   ├── Update.php
    │   └── Request.php
    ├── AccountLink.php
    ├── ApiResponse.php
    ├── BitcoinTransaction.php
    ├── Util
    │   ├── DefaultLogger.php
    │   ├── Set.php
    │   ├── RandomGenerator.php
    │   ├── LoggerInterface.php
    │   └── CaseInsensitiveArray.php
    ├── HttpClient
    │   └── ClientInterface.php
    ├── OAuthErrorObject.php
    ├── UsageRecord.php
    ├── RecipientTransfer.php
    ├── SingletonApiResource.php
    ├── ApplePayDomain.php
    ├── Mandate.php
    ├── Radar
    │   ├── ValueListItem.php
    │   ├── ValueList.php
    │   └── EarlyFraudWarning.php
    ├── ExchangeRate.php
    ├── FileLink.php
    ├── BillingPortal
    │   └── Session.php
    ├── Webhook.php
    ├── StripeClientInterface.php
    ├── EphemeralKey.php
    ├── OrderReturn.php
    ├── CountrySpec.php
    ├── CreditNoteLineItem.php
    ├── Sigma
    │   └── ScheduledQueryRun.php
    ├── TaxRate.php
    ├── LineItem.php
    ├── Reporting
    │   ├── ReportType.php
    │   └── ReportRun.php
    ├── Balance.php
    ├── WebhookEndpoint.php
    ├── ThreeDSecure.php
    ├── AlipayAccount.php
    ├── ApplicationFeeRefund.php
    ├── InvoiceLineItem.php
    ├── SKU.php
    ├── Coupon.php
    ├── Recipient.php
    ├── Capability.php
    ├── File.php
    └── Review.php
├── phpstan.neon.dist
├── .editorconfig
├── phpstan-baseline.neon
├── update_certs.php
├── .gitignore
├── phpdoc.dist.xml
├── composer.json
├── Makefile
├── LICENSE
└── .php_cs.dist


/VERSION:
--------------------------------------------------------------------------------
1 | 7.37.1
2 | 


--------------------------------------------------------------------------------
/.coveralls.github-actions.yml:
--------------------------------------------------------------------------------
1 | service_name: github-actions
2 | coverage_clover: clover.xml
3 | json_path: coveralls-upload.json
4 | 


--------------------------------------------------------------------------------
/lib/Exception/BadMethodCallException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Stripe\Exception;
4 | 
5 | class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/lib/Exception/InvalidArgumentException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Stripe\Exception;
4 | 
5 | class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/lib/Exception/UnexpectedValueException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Stripe\Exception;
4 | 
5 | class UnexpectedValueException extends \UnexpectedValueException implements ExceptionInterface
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
 1 | includes:
 2 | 	- phpstan-baseline.neon
 3 | 
 4 | parameters:
 5 | 	level: 1
 6 | 
 7 | 	bootstrap: tests/bootstrap.php
 8 | 
 9 | 	ignoreErrors:
10 | 		- '#Unsafe usage of new static\(\).#'
11 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/ExceptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * The base interface for all Stripe OAuth exceptions.
 7 |  */
 8 | interface ExceptionInterface extends \Stripe\Exception\ExceptionInterface
 9 | {
10 | }
11 | 


--------------------------------------------------------------------------------
/lib/Exception/IdempotencyException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * IdempotencyException is thrown in cases where an idempotency key was used
 7 |  * improperly.
 8 |  */
 9 | class IdempotencyException extends ApiErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/InvalidScopeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * InvalidScopeException is thrown when an invalid scope parameter is provided.
 7 |  */
 8 | class InvalidScopeException extends OAuthErrorException
 9 | {
10 | }
11 | 


--------------------------------------------------------------------------------
/lib/Exception/PermissionException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * PermissionException is thrown in cases where access was attempted on a
 7 |  * resource that wasn't allowed.
 8 |  */
 9 | class PermissionException extends ApiErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/lib/Exception/AuthenticationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * AuthenticationException is thrown when invalid credentials are used to
 7 |  * connect to Stripe's servers.
 8 |  */
 9 | class AuthenticationException extends ApiErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/UnsupportedGrantTypeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * UnsupportedGrantTypeException is thrown when an unuspported grant type
 7 |  * parameter is specified.
 8 |  */
 9 | class UnsupportedGrantTypeException extends OAuthErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/InvalidRequestException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * InvalidRequestException is thrown when a code, refresh token, or grant
 7 |  * type parameter is not provided, but was required.
 8 |  */
 9 | class InvalidRequestException extends OAuthErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/UnsupportedResponseTypeException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * UnsupportedResponseTypeException is thrown when an unsupported response type
 7 |  * parameter is specified.
 8 |  */
 9 | class UnsupportedResponseTypeException extends OAuthErrorException
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | ; https://editorconfig.org/
 2 | 
 3 | root = true
 4 | 
 5 | [*]
 6 | indent_style = space
 7 | indent_size = 4
 8 | insert_final_newline = true
 9 | trim_trailing_whitespace = true
10 | end_of_line = lf
11 | charset = utf-8
12 | 
13 | [*.{json,yml}]
14 | indent_size = 2
15 | 
16 | [*.neon]
17 | indent_style = tab
18 | 
19 | [Makefile]
20 | indent_style = tab
21 | 


--------------------------------------------------------------------------------
/lib/Exception/ApiConnectionException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * ApiConnection is thrown in the event that the SDK can't connect to Stripe's
 7 |  * servers. That can be for a variety of different reasons from a downed
 8 |  * network to a bad TLS certificate.
 9 |  */
10 | class ApiConnectionException extends ApiErrorException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/lib/Exception/RateLimitException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * RateLimitException is thrown in cases where an account is putting too much
 7 |  * load on Stripe's API servers (usually by performing too many requests).
 8 |  * Please back off on request rate.
 9 |  */
10 | class RateLimitException extends InvalidRequestException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/phpstan-baseline.neon:
--------------------------------------------------------------------------------
 1 | parameters:
 2 | 	ignoreErrors:
 3 | 		-
 4 | 			message: "#^Access to undefined constant Stripe\\\\ApiResource\\:\\:OBJECT_NAME\\.$#"
 5 | 			count: 1
 6 | 			path: lib/ApiResource.php
 7 | 
 8 | 		-
 9 | 			message: "#^Access to undefined constant Stripe\\\\SingletonApiResource\\:\\:OBJECT_NAME\\.$#"
10 | 			count: 1
11 | 			path: lib/SingletonApiResource.php
12 | 
13 | 


--------------------------------------------------------------------------------
/lib/Discount.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class Discount.
 7 |  *
 8 |  * @property string $object
 9 |  * @property Coupon $coupon
10 |  * @property string $customer
11 |  * @property int $end
12 |  * @property int $start
13 |  * @property string $subscription
14 |  */
15 | class Discount extends StripeObject
16 | {
17 |     const OBJECT_NAME = 'discount';
18 | }
19 | 


--------------------------------------------------------------------------------
/lib/Exception/UnknownApiErrorException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * UnknownApiErrorException is thrown when the client library receives an
 7 |  * error from the API it doesn't know about. Receiving this error usually
 8 |  * means that your client library is outdated and should be upgraded.
 9 |  */
10 | class UnknownApiErrorException extends ApiErrorException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/lib/OrderItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class OrderItem.
 7 |  *
 8 |  * @property string $object
 9 |  * @property int $amount
10 |  * @property string $currency
11 |  * @property string $description
12 |  * @property string $parent
13 |  * @property int $quantity
14 |  * @property string $type
15 |  */
16 | class OrderItem extends StripeObject
17 | {
18 |     const OBJECT_NAME = 'order_item';
19 | }
20 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/InvalidClientException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * InvalidClientException is thrown when the client_id does not belong to you,
 7 |  * the stripe_user_id does not exist or is not connected to your application,
 8 |  * or the API key mode (live or test mode) does not match the client_id mode.
 9 |  */
10 | class InvalidClientException extends OAuthErrorException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/UnknownOAuthErrorException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * UnknownApiErrorException is thrown when the client library receives an
 7 |  * error from the OAuth API it doesn't know about. Receiving this error usually
 8 |  * means that your client library is outdated and should be upgraded.
 9 |  */
10 | class UnknownOAuthErrorException extends OAuthErrorException
11 | {
12 | }
13 | 


--------------------------------------------------------------------------------
/lib/LoginLink.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 7 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 8 |  * @property string $url The URL for the login link.
 9 |  */
10 | class LoginLink extends ApiResource
11 | {
12 |     const OBJECT_NAME = 'login_link';
13 | }
14 | 


--------------------------------------------------------------------------------
/lib/Issuing/CardDetails.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Issuing;
 4 | 
 5 | /**
 6 |  * Class CardDetails.
 7 |  *
 8 |  * @property string $id
 9 |  * @property string $object
10 |  * @property Card $card
11 |  * @property string $cvc
12 |  * @property int $exp_month
13 |  * @property int $exp_year
14 |  * @property string $number
15 |  */
16 | class CardDetails extends \Stripe\ApiResource
17 | {
18 |     const OBJECT_NAME = 'issuing.card_details';
19 | }
20 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/InvalidGrantException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * InvalidGrantException is thrown when a specified code doesn't exist, is
 7 |  * expired, has been used, or doesn't belong to you; a refresh token doesn't
 8 |  * exist, or doesn't belong to you; or if an API key's mode (live or test)
 9 |  * doesn't match the mode of a code or refresh token.
10 |  */
11 | class InvalidGrantException extends OAuthErrorException
12 | {
13 | }
14 | 


--------------------------------------------------------------------------------
/update_certs.php:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env php
 2 | <?php
 3 | \chdir(__DIR__);
 4 | 
 5 | \set_time_limit(0); // unlimited max execution time
 6 | 
 7 | $fp = \fopen(__DIR__ . '/data/ca-certificates.crt', 'w+b');
 8 | 
 9 | $options = [
10 |     \CURLOPT_FILE => $fp,
11 |     \CURLOPT_TIMEOUT => 3600,
12 |     \CURLOPT_URL => 'https://curl.haxx.se/ca/cacert.pem',
13 | ];
14 | 
15 | $ch = \curl_init();
16 | \curl_setopt_array($ch, $options);
17 | \curl_exec($ch);
18 | \curl_close($ch);
19 | \fclose($fp);
20 | 


--------------------------------------------------------------------------------
/lib/SourceTransaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class SourceTransaction.
 7 |  *
 8 |  * @property string $id
 9 |  * @property string $object
10 |  * @property \Stripe\StripeObject $ach_credit_transfer
11 |  * @property int $amount
12 |  * @property int $created
13 |  * @property string $customer_data
14 |  * @property string $currency
15 |  * @property string $type
16 |  */
17 | class SourceTransaction extends ApiResource
18 | {
19 |     const OBJECT_NAME = 'source_transaction';
20 | }
21 | 


--------------------------------------------------------------------------------
/lib/Exception/OAuth/OAuthErrorException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception\OAuth;
 4 | 
 5 | /**
 6 |  * Implements properties and methods common to all (non-SPL) Stripe OAuth
 7 |  * exceptions.
 8 |  */
 9 | abstract class OAuthErrorException extends \Stripe\Exception\ApiErrorException
10 | {
11 |     protected function constructErrorObject()
12 |     {
13 |         if (null === $this->jsonBody) {
14 |             return null;
15 |         }
16 | 
17 |         return \Stripe\OAuthErrorObject::constructFrom($this->jsonBody);
18 |     }
19 | }
20 | 


--------------------------------------------------------------------------------
/lib/Exception/ExceptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | // TODO: remove this check once we drop support for PHP 5
 6 | if (\interface_exists(\Throwable::class, false)) {
 7 |     /**
 8 |      * The base interface for all Stripe exceptions.
 9 |      */
10 |     interface ExceptionInterface extends \Throwable
11 |     {
12 |     }
13 | } else {
14 |     /**
15 |      * The base interface for all Stripe exceptions.
16 |      */
17 |     // phpcs:disable PSR1.Classes.ClassDeclaration.MultipleClasses
18 |     interface ExceptionInterface
19 |     {
20 |     }
21 |     // phpcs:enable
22 | }
23 | 


--------------------------------------------------------------------------------
/lib/Service/Checkout/CheckoutServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Checkout;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Checkout namespace.
 7 |  *
 8 |  * @property SessionService $sessions
 9 |  */
10 | class CheckoutServiceFactory extends \Stripe\Service\AbstractServiceFactory
11 | {
12 |     /**
13 |      * @var array<string, string>
14 |      */
15 |     private static $classMap = [
16 |         'sessions' => SessionService::class,
17 |     ];
18 | 
19 |     protected function getServiceClass($name)
20 |     {
21 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/RequestTelemetry.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class RequestTelemetry.
 7 |  *
 8 |  * Tracks client request telemetry
 9 |  */
10 | class RequestTelemetry
11 | {
12 |     public $requestId;
13 |     public $requestDuration;
14 | 
15 |     /**
16 |      * Initialize a new telemetry object.
17 |      *
18 |      * @param string $requestId the request's request ID
19 |      * @param int $requestDuration the request's duration in milliseconds
20 |      */
21 |     public function __construct($requestId, $requestDuration)
22 |     {
23 |         $this->requestId = $requestId;
24 |         $this->requestDuration = $requestDuration;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/lib/Service/MandateService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class MandateService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Retrieves a Mandate object.
 9 |      *
10 |      * @param string $id
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Mandate
17 |      */
18 |     public function retrieve($id, $params = null, $opts = null)
19 |     {
20 |         return $this->request('get', $this->buildPath('/v1/mandates/%s', $id), $params, $opts);
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/lib/Service/BillingPortal/SessionService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\BillingPortal;
 4 | 
 5 | class SessionService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Creates a session of the customer portal.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\BillingPortal\Session
16 |      */
17 |     public function create($params = null, $opts = null)
18 |     {
19 |         return $this->request('post', '/v1/billing_portal/sessions', $params, $opts);
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/lib/Service/BillingPortal/BillingPortalServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\BillingPortal;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the BillingPortal namespace.
 7 |  *
 8 |  * @property SessionService $sessions
 9 |  */
10 | class BillingPortalServiceFactory extends \Stripe\Service\AbstractServiceFactory
11 | {
12 |     /**
13 |      * @var array<string, string>
14 |      */
15 |     private static $classMap = [
16 |         'sessions' => SessionService::class,
17 |     ];
18 | 
19 |     protected function getServiceClass($name)
20 |     {
21 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/Service/Sigma/SigmaServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Sigma;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Sigma namespace.
 7 |  *
 8 |  * @property ScheduledQueryRunService $scheduledQueryRuns
 9 |  */
10 | class SigmaServiceFactory extends \Stripe\Service\AbstractServiceFactory
11 | {
12 |     /**
13 |      * @var array<string, string>
14 |      */
15 |     private static $classMap = [
16 |         'scheduledQueryRuns' => ScheduledQueryRunService::class,
17 |     ];
18 | 
19 |     protected function getServiceClass($name)
20 |     {
21 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Ignore build files
 2 | build/*
 3 | 
 4 | # Mac OS X dumps these all over the place.
 5 | .DS_Store
 6 | 
 7 | # Ignore the SimpleTest library if it is installed to /test/.
 8 | /test/simpletest/
 9 | 
10 | # Ignore the /vendor/ directory for people using composer
11 | /vendor/
12 | 
13 | # If the vendor directory isn't being commited the composer.lock file should also be ignored
14 | composer.lock
15 | 
16 | # Ignore PHPUnit coverage file
17 | clover.xml
18 | 
19 | # Ignore IDE's configuration files
20 | .idea
21 | 
22 | # Ignore PHP CS Fixer local config and cache
23 | .php_cs
24 | .php_cs.cache
25 | 
26 | # Ignore PHPStan local config
27 | .phpstan.neon
28 | 
29 | # Ignore phpDocumentor's local config and artifacts
30 | .phpdoc/*
31 | phpdoc.xml
32 | 


--------------------------------------------------------------------------------
/lib/Service/Reporting/ReportingServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Reporting;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Reporting namespace.
 7 |  *
 8 |  * @property ReportRunService $reportRuns
 9 |  * @property ReportTypeService $reportTypes
10 |  */
11 | class ReportingServiceFactory extends \Stripe\Service\AbstractServiceFactory
12 | {
13 |     /**
14 |      * @var array<string, string>
15 |      */
16 |     private static $classMap = [
17 |         'reportRuns' => ReportRunService::class,
18 |         'reportTypes' => ReportTypeService::class,
19 |     ];
20 | 
21 |     protected function getServiceClass($name)
22 |     {
23 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/lib/Service/AccountLinkService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class AccountLinkService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Creates an AccountLink object that returns a single-use Stripe URL that the user
 9 |      * can redirect their user to in order to take them through the Connect Onboarding
10 |      * flow.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\AccountLink
18 |      */
19 |     public function create($params = null, $opts = null)
20 |     {
21 |         return $this->request('post', '/v1/account_links', $params, $opts);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/Terminal/ConnectionToken.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Terminal;
 4 | 
 5 | /**
 6 |  * A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
 7 |  *
 8 |  * Related guide: <a
 9 |  * href="https://stripe.com/docs/terminal/readers/fleet-management#create">Fleet
10 |  * Management</a>.
11 |  *
12 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
13 |  * @property string $location The id of the location that this connection token is scoped to.
14 |  * @property string $secret Your application should pass this token to the Stripe Terminal SDK.
15 |  */
16 | class ConnectionToken extends \Stripe\ApiResource
17 | {
18 |     const OBJECT_NAME = 'terminal.connection_token';
19 | 
20 |     use \Stripe\ApiOperations\Create;
21 | }
22 | 


--------------------------------------------------------------------------------
/lib/UsageRecordSummary.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property null|string $invoice The invoice in which this usage period has been billed for.
 9 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
10 |  * @property \Stripe\StripeObject $period
11 |  * @property string $subscription_item The ID of the subscription item this summary is describing.
12 |  * @property int $total_usage The total usage within this usage period.
13 |  */
14 | class UsageRecordSummary extends ApiResource
15 | {
16 |     const OBJECT_NAME = 'usage_record_summary';
17 | }
18 | 


--------------------------------------------------------------------------------
/lib/Service/BalanceService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class BalanceService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Retrieves the current account balance, based on the authentication that was used
 9 |      * to make the request.  For a sample request, see <a
10 |      * href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting
11 |      * for negative balances</a>.
12 |      *
13 |      * @param null|array $params
14 |      * @param null|array|\Stripe\Util\RequestOptions $opts
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return \Stripe\Balance
19 |      */
20 |     public function retrieve($params = null, $opts = null)
21 |     {
22 |         return $this->request('get', '/v1/balance', $params, $opts);
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/lib/Service/Terminal/TerminalServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Terminal;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Terminal namespace.
 7 |  *
 8 |  * @property ConnectionTokenService $connectionTokens
 9 |  * @property LocationService $locations
10 |  * @property ReaderService $readers
11 |  */
12 | class TerminalServiceFactory extends \Stripe\Service\AbstractServiceFactory
13 | {
14 |     /**
15 |      * @var array<string, string>
16 |      */
17 |     private static $classMap = [
18 |         'connectionTokens' => ConnectionTokenService::class,
19 |         'locations' => LocationService::class,
20 |         'readers' => ReaderService::class,
21 |     ];
22 | 
23 |     protected function getServiceClass($name)
24 |     {
25 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/Delete.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for deletable resources. Adds a `delete()` method to the class.
 7 |  *
 8 |  * This trait should only be applied to classes that derive from StripeObject.
 9 |  */
10 | trait Delete
11 | {
12 |     /**
13 |      * @param null|array $params
14 |      * @param null|array|string $opts
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return static the deleted resource
19 |      */
20 |     public function delete($params = null, $opts = null)
21 |     {
22 |         self::_validateParams($params);
23 | 
24 |         $url = $this->instanceUrl();
25 |         list($response, $opts) = $this->_request('delete', $url, $params, $opts);
26 |         $this->refreshFrom($response, $opts);
27 | 
28 |         return $this;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Service/Terminal/ConnectionTokenService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Terminal;
 4 | 
 5 | class ConnectionTokenService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived
 9 |      * connection token from Stripe, proxied through your server. On your backend, add
10 |      * an endpoint that creates and returns a connection token.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Terminal\ConnectionToken
18 |      */
19 |     public function create($params = null, $opts = null)
20 |     {
21 |         return $this->request('post', '/v1/terminal/connection_tokens', $params, $opts);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/AccountLink.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Account Links are the means by which a Connect platform grants a connected
 7 |  * account permission to access Stripe-hosted applications, such as Connect
 8 |  * Onboarding.
 9 |  *
10 |  * Related guide: <a
11 |  * href="https://stripe.com/docs/connect/connect-onboarding">Connect
12 |  * Onboarding</a>.
13 |  *
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16 |  * @property int $expires_at The timestamp at which this account link will expire.
17 |  * @property string $url The URL for the account link.
18 |  */
19 | class AccountLink extends ApiResource
20 | {
21 |     const OBJECT_NAME = 'account_link';
22 | 
23 |     use ApiOperations\Create;
24 | }
25 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/Retrieve.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for retrievable resources. Adds a `retrieve()` static method to the
 7 |  * class.
 8 |  *
 9 |  * This trait should only be applied to classes that derive from StripeObject.
10 |  */
11 | trait Retrieve
12 | {
13 |     /**
14 |      * @param array|string $id the ID of the API resource to retrieve,
15 |      *     or an options array containing an `id` key
16 |      * @param null|array|string $opts
17 |      *
18 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
19 |      *
20 |      * @return static
21 |      */
22 |     public static function retrieve($id, $opts = null)
23 |     {
24 |         $opts = \Stripe\Util\RequestOptions::parse($opts);
25 |         $instance = new static($id, $opts);
26 |         $instance->refresh();
27 | 
28 |         return $instance;
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Service/Radar/RadarServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Radar;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Radar namespace.
 7 |  *
 8 |  * @property EarlyFraudWarningService $earlyFraudWarnings
 9 |  * @property ValueListItemService $valueListItems
10 |  * @property ValueListService $valueLists
11 |  */
12 | class RadarServiceFactory extends \Stripe\Service\AbstractServiceFactory
13 | {
14 |     /**
15 |      * @var array<string, string>
16 |      */
17 |     private static $classMap = [
18 |         'earlyFraudWarnings' => EarlyFraudWarningService::class,
19 |         'valueListItems' => ValueListItemService::class,
20 |         'valueLists' => ValueListService::class,
21 |     ];
22 | 
23 |     protected function getServiceClass($name)
24 |     {
25 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/lib/ApiResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | use Stripe\Util\CaseInsensitiveArray;
 6 | 
 7 | /**
 8 |  * Class ApiResponse.
 9 |  */
10 | class ApiResponse
11 | {
12 |     /**
13 |      * @var null|array|CaseInsensitiveArray
14 |      */
15 |     public $headers;
16 | 
17 |     /**
18 |      * @var string
19 |      */
20 |     public $body;
21 | 
22 |     /**
23 |      * @var null|array
24 |      */
25 |     public $json;
26 | 
27 |     /**
28 |      * @var int
29 |      */
30 |     public $code;
31 | 
32 |     /**
33 |      * @param string $body
34 |      * @param int $code
35 |      * @param null|array|CaseInsensitiveArray $headers
36 |      * @param null|array $json
37 |      */
38 |     public function __construct($body, $code, $headers, $json)
39 |     {
40 |         $this->body = $body;
41 |         $this->code = $code;
42 |         $this->headers = $headers;
43 |         $this->json = $json;
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/lib/BitcoinTransaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property int $amount The amount of <code>currency</code> that the transaction was converted to in real-time.
 9 |  * @property int $bitcoin_amount The amount of bitcoin contained in the transaction.
10 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
11 |  * @property string $currency Three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> to which this transaction was converted.
12 |  * @property string $receiver The receiver to which this transaction was sent.
13 |  */
14 | class BitcoinTransaction extends ApiResource
15 | {
16 |     const OBJECT_NAME = 'bitcoin_transaction';
17 | }
18 | 


--------------------------------------------------------------------------------
/lib/Util/DefaultLogger.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Util;
 4 | 
 5 | /**
 6 |  * A very basic implementation of LoggerInterface that has just enough
 7 |  * functionality that it can be the default for this library.
 8 |  */
 9 | class DefaultLogger implements LoggerInterface
10 | {
11 |     /** @var int */
12 |     public $messageType = 0;
13 | 
14 |     /** @var null|string */
15 |     public $destination;
16 | 
17 |     public function error($message, array $context = [])
18 |     {
19 |         if (\count($context) > 0) {
20 |             throw new \Stripe\Exception\BadMethodCallException('DefaultLogger does not currently implement context. Please implement if you need it.');
21 |         }
22 | 
23 |         if (null === $this->destination) {
24 |             \error_log($message, $this->messageType);
25 |         } else {
26 |             \error_log($message, $this->messageType, $this->destination);
27 |         }
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/lib/Util/Set.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Util;
 4 | 
 5 | use ArrayIterator;
 6 | use IteratorAggregate;
 7 | 
 8 | class Set implements IteratorAggregate
 9 | {
10 |     private $_elts;
11 | 
12 |     public function __construct($members = [])
13 |     {
14 |         $this->_elts = [];
15 |         foreach ($members as $item) {
16 |             $this->_elts[$item] = true;
17 |         }
18 |     }
19 | 
20 |     public function includes($elt)
21 |     {
22 |         return isset($this->_elts[$elt]);
23 |     }
24 | 
25 |     public function add($elt)
26 |     {
27 |         $this->_elts[$elt] = true;
28 |     }
29 | 
30 |     public function discard($elt)
31 |     {
32 |         unset($this->_elts[$elt]);
33 |     }
34 | 
35 |     public function toArray()
36 |     {
37 |         return \array_keys($this->_elts);
38 |     }
39 | 
40 |     public function getIterator()
41 |     {
42 |         return new ArrayIterator($this->toArray());
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/Create.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for creatable resources. Adds a `create()` static method to the class.
 7 |  *
 8 |  * This trait should only be applied to classes that derive from StripeObject.
 9 |  */
10 | trait Create
11 | {
12 |     /**
13 |      * @param null|array $params
14 |      * @param null|array|string $options
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return static the created resource
19 |      */
20 |     public static function create($params = null, $options = null)
21 |     {
22 |         self::_validateParams($params);
23 |         $url = static::classUrl();
24 | 
25 |         list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
26 |         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
27 |         $obj->setLastResponse($response);
28 | 
29 |         return $obj;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/lib/Util/RandomGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Util;
 4 | 
 5 | /**
 6 |  * A basic random generator. This is in a separate class so we the generator
 7 |  * can be injected as a dependency and replaced with a mock in tests.
 8 |  */
 9 | class RandomGenerator
10 | {
11 |     /**
12 |      * Returns a random value between 0 and $max.
13 |      *
14 |      * @param float $max (optional)
15 |      *
16 |      * @return float
17 |      */
18 |     public function randFloat($max = 1.0)
19 |     {
20 |         return \mt_rand() / \mt_getrandmax() * $max;
21 |     }
22 | 
23 |     /**
24 |      * Returns a v4 UUID.
25 |      *
26 |      * @return string
27 |      */
28 |     public function uuid()
29 |     {
30 |         $arr = \array_values(\unpack('N1a/n4b/N1c', \openssl_random_pseudo_bytes(16)));
31 |         $arr[2] = ($arr[2] & 0x0fff) | 0x4000;
32 |         $arr[3] = ($arr[3] & 0x3fff) | 0x8000;
33 | 
34 |         return \vsprintf('%08x-%04x-%04x-%04x-%04x%08x', $arr);
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/lib/HttpClient/ClientInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\HttpClient;
 4 | 
 5 | interface ClientInterface
 6 | {
 7 |     /**
 8 |      * @param string $method The HTTP method being used
 9 |      * @param string $absUrl The URL being requested, including domain and protocol
10 |      * @param array $headers Headers to be used in the request (full strings, not KV pairs)
11 |      * @param array $params KV pairs for parameters. Can be nested for arrays and hashes
12 |      * @param bool $hasFile Whether or not $params references a file (via an @ prefix or
13 |      *                         CURLFile)
14 |      *
15 |      * @throws \Stripe\Exception\ApiConnectionException
16 |      * @throws \Stripe\Exception\UnexpectedValueException
17 |      *
18 |      * @return array an array whose first element is raw request body, second
19 |      *    element is HTTP status code and third array of HTTP headers
20 |      */
21 |     public function request($method, $absUrl, $headers, $params, $hasFile);
22 | }
23 | 


--------------------------------------------------------------------------------
/lib/OAuthErrorObject.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class OAuthErrorObject.
 7 |  *
 8 |  * @property string $error
 9 |  * @property string $error_description
10 |  */
11 | class OAuthErrorObject extends StripeObject
12 | {
13 |     /**
14 |      * Refreshes this object using the provided values.
15 |      *
16 |      * @param array $values
17 |      * @param null|array|string|Util\RequestOptions $opts
18 |      * @param bool $partial defaults to false
19 |      */
20 |     public function refreshFrom($values, $opts, $partial = false)
21 |     {
22 |         // Unlike most other API resources, the API will omit attributes in
23 |         // error objects when they have a null value. We manually set default
24 |         // values here to facilitate generic error handling.
25 |         $values = \array_merge([
26 |             'error' => null,
27 |             'error_description' => null,
28 |         ], $values);
29 |         parent::refreshFrom($values, $opts, $partial);
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/lib/UsageRecord.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Usage records allow you to report customer usage and metrics to Stripe for
 7 |  * metered billing of subscription plans.
 8 |  *
 9 |  * Related guide: <a
10 |  * href="https://stripe.com/docs/billing/subscriptions/metered-billing">Metered
11 |  * Billing</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
16 |  * @property int $quantity The usage quantity for the specified date.
17 |  * @property string $subscription_item The ID of the subscription item this usage record contains data for.
18 |  * @property int $timestamp The timestamp when this usage occurred.
19 |  */
20 | class UsageRecord extends ApiResource
21 | {
22 |     const OBJECT_NAME = 'usage_record';
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/Service/Issuing/IssuingServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Issuing;
 4 | 
 5 | /**
 6 |  * Service factory class for API resources in the Issuing namespace.
 7 |  *
 8 |  * @property AuthorizationService $authorizations
 9 |  * @property CardholderService $cardholders
10 |  * @property CardService $cards
11 |  * @property DisputeService $disputes
12 |  * @property TransactionService $transactions
13 |  */
14 | class IssuingServiceFactory extends \Stripe\Service\AbstractServiceFactory
15 | {
16 |     /**
17 |      * @var array<string, string>
18 |      */
19 |     private static $classMap = [
20 |         'authorizations' => AuthorizationService::class,
21 |         'cardholders' => CardholderService::class,
22 |         'cards' => CardService::class,
23 |         'disputes' => DisputeService::class,
24 |         'transactions' => TransactionService::class,
25 |     ];
26 | 
27 |     protected function getServiceClass($name)
28 |     {
29 |         return \array_key_exists($name, self::$classMap) ? self::$classMap[$name] : null;
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/lib/RecipientTransfer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class RecipientTransfer.
 7 |  *
 8 |  * @property string $id
 9 |  * @property string $object
10 |  * @property int $amount
11 |  * @property int $amount_reversed
12 |  * @property string $balance_transaction
13 |  * @property string $bank_account
14 |  * @property string $card
15 |  * @property int $created
16 |  * @property string $currency
17 |  * @property int $date
18 |  * @property string $description
19 |  * @property string $destination
20 |  * @property string $failure_code
21 |  * @property string $failure_message
22 |  * @property bool $livemode
23 |  * @property \Stripe\StripeObject $metadata
24 |  * @property string $method
25 |  * @property string $recipient
26 |  * @property \Stripe\Collection $reversals
27 |  * @property bool $reversed
28 |  * @property string $source_type
29 |  * @property string $statement_descriptor
30 |  * @property string $status
31 |  * @property string $type
32 |  */
33 | class RecipientTransfer extends ApiResource
34 | {
35 |     const OBJECT_NAME = 'recipient_transfer';
36 | }
37 | 


--------------------------------------------------------------------------------
/lib/SingletonApiResource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class SingletonApiResource.
 7 |  */
 8 | abstract class SingletonApiResource extends ApiResource
 9 | {
10 |     protected static function _singletonRetrieve($options = null)
11 |     {
12 |         $opts = Util\RequestOptions::parse($options);
13 |         $instance = new static(null, $opts);
14 |         $instance->refresh();
15 | 
16 |         return $instance;
17 |     }
18 | 
19 |     /**
20 |      * @return string the endpoint associated with this singleton class
21 |      */
22 |     public static function classUrl()
23 |     {
24 |         // Replace dots with slashes for namespaced resources, e.g. if the object's name is
25 |         // "foo.bar", then its URL will be "/v1/foo/bar".
26 |         $base = \str_replace('.', '/', static::OBJECT_NAME);
27 | 
28 |         return "/v1/{$base}";
29 |     }
30 | 
31 |     /**
32 |      * @return string the endpoint associated with this singleton API resource
33 |      */
34 |     public function instanceUrl()
35 |     {
36 |         return static::classUrl();
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/lib/ApplePayDomain.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 9 |  * @property string $domain_name
10 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
11 |  */
12 | class ApplePayDomain extends ApiResource
13 | {
14 |     const OBJECT_NAME = 'apple_pay_domain';
15 | 
16 |     use ApiOperations\All;
17 |     use ApiOperations\Create;
18 |     use ApiOperations\Delete;
19 |     use ApiOperations\Retrieve;
20 | 
21 |     /**
22 |      * @return string The class URL for this resource. It needs to be special
23 |      *    cased because it doesn't fit into the standard resource pattern.
24 |      */
25 |     public static function classUrl()
26 |     {
27 |         return '/v1/apple_pay/domains';
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/phpdoc.dist.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8" ?>
 2 | <phpdocumentor
 3 |         configVersion="3"
 4 |         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 5 |         xmlns="http://www.phpdoc.org"
 6 |         xsi:noNamespaceSchemaLocation="data/xsd/phpdoc.xsd"
 7 | >
 8 |     <paths>
 9 |         <output>build/phpdoc</output>
10 |     </paths>
11 |     <version number="3.0.0">
12 |         <folder>latest</folder>
13 |         <api>
14 |             <source dsn=".">
15 |                 <path>lib</path>
16 |             </source>
17 |             <output>api</output>
18 |             <ignore hidden="true" symlinks="true">
19 |                 <path>build/**/*</path>
20 |                 <path>examples/**/*</path>
21 |                 <path>tests/**/*</path>
22 |                 <path>vendor/**/*</path>
23 |             </ignore>
24 |             <extensions>
25 |                 <extension>php</extension>
26 |             </extensions>
27 |             <default-package-name>stripe-php</default-package-name>
28 |         </api>
29 |     </version>
30 |     <template name="default"/>
31 | </phpdocumentor>
32 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "stripe/stripe-php",
 3 |   "description": "Stripe PHP Library",
 4 |   "keywords": [
 5 |     "stripe",
 6 |     "payment processing",
 7 |     "api"
 8 |   ],
 9 |   "homepage": "https://stripe.com/",
10 |   "license": "MIT",
11 |   "authors": [
12 |     {
13 |       "name": "Stripe and contributors",
14 |       "homepage": "https://github.com/stripe/stripe-php/contributors"
15 |     }
16 |   ],
17 |   "require": {
18 |     "php": ">=5.6.0",
19 |     "ext-curl": "*",
20 |     "ext-json": "*",
21 |     "ext-mbstring": "*"
22 |   },
23 |   "require-dev": {
24 |     "phpunit/phpunit": "^5.7",
25 |     "php-coveralls/php-coveralls": "^2.1",
26 |     "squizlabs/php_codesniffer": "^3.3",
27 |     "symfony/process": "~3.4",
28 |     "friendsofphp/php-cs-fixer": "2.16.1"
29 |   },
30 |   "autoload": {
31 |     "psr-4": {
32 |       "Stripe\\": "lib/"
33 |     }
34 |   },
35 |   "autoload-dev": {
36 |     "psr-4": {
37 |       "Stripe\\": [
38 |         "tests/",
39 |         "tests/Stripe/"
40 |       ]
41 |     }
42 |   },
43 |   "extra": {
44 |     "branch-alias": {
45 |       "dev-master": "2.0-dev"
46 |     }
47 |   }
48 | }
49 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | export PHPDOCUMENTOR_VERSION := v3.0.0-rc
 2 | export PHPSTAN_VERSION := 0.12.18
 3 | 
 4 | vendor: composer.json
 5 | 	composer install
 6 | 
 7 | vendor/bin/phpstan: vendor
 8 | 	curl -sfL https://github.com/phpstan/phpstan/releases/download/$(PHPSTAN_VERSION)/phpstan.phar -o vendor/bin/phpstan
 9 | 	chmod +x vendor/bin/phpstan
10 | 
11 | vendor/bin/phpdoc: vendor
12 | 	curl -sfL https://github.com/phpDocumentor/phpDocumentor/releases/download/$(PHPDOCUMENTOR_VERSION)/phpDocumentor.phar -o vendor/bin/phpdoc
13 | 	chmod +x vendor/bin/phpdoc
14 | 
15 | test: vendor
16 | 	vendor/bin/phpunit
17 | .PHONY: test
18 | 
19 | fmt: vendor
20 | 	vendor/bin/php-cs-fixer fix -v --using-cache=no .
21 | .PHONY: fmt
22 | 
23 | fmtcheck: vendor
24 | 	vendor/bin/php-cs-fixer fix -v --dry-run --using-cache=no .
25 | .PHONY: fmtcheck
26 | 
27 | phpdoc: vendor/bin/phpdoc
28 | 	vendor/bin/phpdoc
29 | 
30 | phpstan: vendor/bin/phpstan
31 | 	php -d memory_limit=512M vendor/bin/phpstan analyse lib tests
32 | .PHONY: phpstan
33 | 
34 | phpstan-baseline: vendor/bin/phpstan
35 | 	php -d memory_limit=512M vendor/bin/phpstan analyse lib tests --generate-baseline
36 | .PHONY: phpstan-baseline
37 | 


--------------------------------------------------------------------------------
/lib/Mandate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * A Mandate is a record of the permission a customer has given you to debit their
 7 |  * payment method.
 8 |  *
 9 |  * @property string $id Unique identifier for the object.
10 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
11 |  * @property \Stripe\StripeObject $customer_acceptance
12 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
13 |  * @property \Stripe\StripeObject $multi_use
14 |  * @property string|\Stripe\PaymentMethod $payment_method ID of the payment method associated with this mandate.
15 |  * @property \Stripe\StripeObject $payment_method_details
16 |  * @property \Stripe\StripeObject $single_use
17 |  * @property string $status The status of the mandate, which indicates whether it can be used to initiate a payment.
18 |  * @property string $type The type of the mandate.
19 |  */
20 | class Mandate extends ApiResource
21 | {
22 |     const OBJECT_NAME = 'mandate';
23 | 
24 |     use ApiOperations\Retrieve;
25 | }
26 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License
 2 | 
 3 | Copyright (c) 2010-2019 Stripe, Inc. (https://stripe.com)
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/lib/Service/CountrySpecService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class CountrySpecService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Lists all Country Spec objects available in the API.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/country_specs', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Returns a Country Spec for a given Country code.
24 |      *
25 |      * @param string $id
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\CountrySpec
32 |      */
33 |     public function retrieve($id, $params = null, $opts = null)
34 |     {
35 |         return $this->request('get', $this->buildPath('/v1/country_specs/%s', $id), $params, $opts);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/lib/Service/Sigma/ScheduledQueryRunService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Sigma;
 4 | 
 5 | class ScheduledQueryRunService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of scheduled query runs.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/sigma/scheduled_query_runs', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Retrieves the details of an scheduled query run.
24 |      *
25 |      * @param string $id
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\Sigma\ScheduledQueryRun
32 |      */
33 |     public function retrieve($id, $params = null, $opts = null)
34 |     {
35 |         return $this->request('get', $this->buildPath('/v1/sigma/scheduled_query_runs/%s', $id), $params, $opts);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/All.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for listable resources. Adds a `all()` static method to the class.
 7 |  *
 8 |  * This trait should only be applied to classes that derive from StripeObject.
 9 |  */
10 | trait All
11 | {
12 |     /**
13 |      * @param null|array $params
14 |      * @param null|array|string $opts
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return \Stripe\Collection of ApiResources
19 |      */
20 |     public static function all($params = null, $opts = null)
21 |     {
22 |         self::_validateParams($params);
23 |         $url = static::classUrl();
24 | 
25 |         list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
26 |         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
27 |         if (!($obj instanceof \Stripe\Collection)) {
28 |             throw new \Stripe\Exception\UnexpectedValueException(
29 |                 'Expected type ' . \Stripe\Collection::class . ', got "' . \get_class($obj) . '" instead.'
30 |             );
31 |         }
32 |         $obj->setLastResponse($response);
33 |         $obj->setFilters($params);
34 | 
35 |         return $obj;
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/lib/Util/LoggerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Util;
 4 | 
 5 | /**
 6 |  * Describes a logger instance.
 7 |  *
 8 |  * This is a subset of the interface of the same name in the PSR-3 logger
 9 |  * interface. We guarantee to keep it compatible, but we'd redefined it here so
10 |  * that we don't have to pull in the extra dependencies for users who don't want
11 |  * it.
12 |  *
13 |  * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
14 |  * for the full interface specification.
15 |  *
16 |  * The message MUST be a string or object implementing __toString().
17 |  *
18 |  * The message MAY contain placeholders in the form: {foo} where foo
19 |  * will be replaced by the context data in key "foo".
20 |  *
21 |  * The context array can contain arbitrary data, the only assumption that
22 |  * can be made by implementors is that if an Exception instance is given
23 |  * to produce a stack trace, it MUST be in a key named "exception".
24 |  */
25 | interface LoggerInterface
26 | {
27 |     /**
28 |      * Runtime errors that do not require immediate action but should typically
29 |      * be logged and monitored.
30 |      *
31 |      * @param string $message
32 |      */
33 |     public function error($message, array $context = []);
34 | }
35 | 


--------------------------------------------------------------------------------
/lib/Terminal/Location.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Terminal;
 4 | 
 5 | /**
 6 |  * A Location represents a grouping of readers.
 7 |  *
 8 |  * Related guide: <a
 9 |  * href="https://stripe.com/docs/terminal/readers/fleet-management#create">Fleet
10 |  * Management</a>.
11 |  *
12 |  * @property string $id Unique identifier for the object.
13 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
14 |  * @property \Stripe\StripeObject $address
15 |  * @property string $display_name The display name of the location.
16 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
17 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
18 |  */
19 | class Location extends \Stripe\ApiResource
20 | {
21 |     const OBJECT_NAME = 'terminal.location';
22 | 
23 |     use \Stripe\ApiOperations\All;
24 |     use \Stripe\ApiOperations\Create;
25 |     use \Stripe\ApiOperations\Delete;
26 |     use \Stripe\ApiOperations\Retrieve;
27 |     use \Stripe\ApiOperations\Update;
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/Issuing/Dispute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Issuing;
 4 | 
 5 | /**
 6 |  * As a <a href="https://stripe.com/docs/issuing">card issuer</a>, you can <a
 7 |  * href="https://stripe.com/docs/issuing/purchases/disputes">dispute</a>
 8 |  * transactions that you do not recognize, suspect to be fraudulent, or have some
 9 |  * other issue.
10 |  *
11 |  * Related guide: <a
12 |  * href="https://stripe.com/docs/issuing/purchases/disputes">Disputing
13 |  * Transactions</a>
14 |  *
15 |  * @property string $id Unique identifier for the object.
16 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
17 |  * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this dispute.
18 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
19 |  * @property string|\Stripe\Issuing\Transaction $transaction The transaction being disputed.
20 |  */
21 | class Dispute extends \Stripe\ApiResource
22 | {
23 |     const OBJECT_NAME = 'issuing.dispute';
24 | 
25 |     use \Stripe\ApiOperations\All;
26 |     use \Stripe\ApiOperations\Create;
27 |     use \Stripe\ApiOperations\Retrieve;
28 |     use \Stripe\ApiOperations\Update;
29 | }
30 | 


--------------------------------------------------------------------------------
/lib/Radar/ValueListItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Radar;
 4 | 
 5 | /**
 6 |  * Value list items allow you to add specific values to a given Radar value list,
 7 |  * which can then be used in rules.
 8 |  *
 9 |  * Related guide: <a
10 |  * href="https://stripe.com/docs/radar/lists#managing-list-items">Managing List
11 |  * Items</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16 |  * @property string $created_by The name or email address of the user who added this item to the value list.
17 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
18 |  * @property string $value The value of the item.
19 |  * @property string $value_list The identifier of the value list this item belongs to.
20 |  */
21 | class ValueListItem extends \Stripe\ApiResource
22 | {
23 |     const OBJECT_NAME = 'radar.value_list_item';
24 | 
25 |     use \Stripe\ApiOperations\All;
26 |     use \Stripe\ApiOperations\Create;
27 |     use \Stripe\ApiOperations\Delete;
28 |     use \Stripe\ApiOperations\Retrieve;
29 | }
30 | 


--------------------------------------------------------------------------------
/lib/Service/ExchangeRateService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class ExchangeRateService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of objects that contain the rates at which foreign currencies are
 9 |      * converted to one another. Only shows the currencies for which Stripe supports.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/exchange_rates', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Retrieves the exchange rates from the given currency to every supported
25 |      * currency.
26 |      *
27 |      * @param string $id
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\ExchangeRate
34 |      */
35 |     public function retrieve($id, $params = null, $opts = null)
36 |     {
37 |         return $this->request('get', $this->buildPath('/v1/exchange_rates/%s', $id), $params, $opts);
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/lib/Service/TokenService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class TokenService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Creates a single-use token that represents a bank account’s details. This token
 9 |      * can be used with any API method in place of a bank account dictionary. This
10 |      * token can be used only once, by attaching it to a <a href="#accounts">Custom
11 |      * account</a>.
12 |      *
13 |      * @param null|array $params
14 |      * @param null|array|\Stripe\Util\RequestOptions $opts
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return \Stripe\Token
19 |      */
20 |     public function create($params = null, $opts = null)
21 |     {
22 |         return $this->request('post', '/v1/tokens', $params, $opts);
23 |     }
24 | 
25 |     /**
26 |      * Retrieves the token with the given ID.
27 |      *
28 |      * @param string $id
29 |      * @param null|array $params
30 |      * @param null|array|\Stripe\Util\RequestOptions $opts
31 |      *
32 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
33 |      *
34 |      * @return \Stripe\Token
35 |      */
36 |     public function retrieve($id, $params = null, $opts = null)
37 |     {
38 |         return $this->request('get', $this->buildPath('/v1/tokens/%s', $id), $params, $opts);
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/.php_cs.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return PhpCsFixer\Config::create()
 4 |     ->setRiskyAllowed(true)
 5 |     ->setRules([
 6 |         // Rulesets
 7 |         '@PSR2' => true,
 8 |         '@PhpCsFixer' => true,
 9 |         '@PhpCsFixer:risky' => true,
10 |         '@PHP56Migration:risky' => true,
11 |         '@PHPUnit57Migration:risky' => true,
12 | 
13 |         // Additional rules
14 |         'fopen_flags' => true,
15 |         'linebreak_after_opening_tag' => true,
16 |         'native_function_invocation' => true,
17 | 
18 |         // --- Diffs from @PhpCsFixer / @PhpCsFixer:risky ---
19 | 
20 |         // This is just prettier / easier to read.
21 |         'concat_space' => ['spacing' => 'one'],
22 | 
23 |         // This causes strange ordering with codegen'd classes. We might be
24 |         // able to enable this if we update codegen to output class elements
25 |         // in the correct order.
26 |         'ordered_class_elements' => false,
27 | 
28 |         // Keep this disabled to avoid unnecessary diffs in PHPDoc comments of
29 |         // codegen'd classes.
30 |         'phpdoc_align' => false,
31 | 
32 |         // This is a "risky" rule that causes a bug in our codebase.
33 |         // Specifically, in `StripeObject.updateAttributes` we construct new
34 |         // `StripeObject`s for metadata. We can't use `self` there because it
35 |         // needs to be a raw `StripeObject`.
36 |         'self_accessor' => false,
37 |     ])
38 | ;
39 | 


--------------------------------------------------------------------------------
/lib/Service/EphemeralKeyService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class EphemeralKeyService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Invalidates a short-lived API key for a given resource.
 9 |      *
10 |      * @param string $id
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\EphemeralKey
17 |      */
18 |     public function delete($id, $params = null, $opts = null)
19 |     {
20 |         return $this->request('delete', $this->buildPath('/v1/ephemeral_keys/%s', $id), $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates a short-lived API key for a given resource.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\EphemeralKey
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         if (!$opts || !isset($opts['stripe_version'])) {
36 |             throw new \Stripe\Exception\InvalidArgumentException('stripe_version must be specified to create an ephemeral key');
37 |         }
38 | 
39 |         return $this->request('post', '/v1/ephemeral_keys', $params, $opts);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/lib/Service/Reporting/ReportTypeService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Reporting;
 4 | 
 5 | class ReportTypeService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a full list of Report Types. (Requires a <a
 9 |      * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/reporting/report_types', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Retrieves the details of a Report Type. (Requires a <a
25 |      * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
26 |      *
27 |      * @param string $id
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\Reporting\ReportType
34 |      */
35 |     public function retrieve($id, $params = null, $opts = null)
36 |     {
37 |         return $this->request('get', $this->buildPath('/v1/reporting/report_types/%s', $id), $params, $opts);
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/lib/Service/Radar/EarlyFraudWarningService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Radar;
 4 | 
 5 | class EarlyFraudWarningService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of early fraud warnings.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/radar/early_fraud_warnings', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Retrieves the details of an early fraud warning that has previously been
24 |      * created.
25 |      *
26 |      * Please refer to the <a href="#early_fraud_warning_object">early fraud
27 |      * warning</a> object reference for more details.
28 |      *
29 |      * @param string $id
30 |      * @param null|array $params
31 |      * @param null|array|\Stripe\Util\RequestOptions $opts
32 |      *
33 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
34 |      *
35 |      * @return \Stripe\Radar\EarlyFraudWarning
36 |      */
37 |     public function retrieve($id, $params = null, $opts = null)
38 |     {
39 |         return $this->request('get', $this->buildPath('/v1/radar/early_fraud_warnings/%s', $id), $params, $opts);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/lib/Service/OrderReturnService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class OrderReturnService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your order returns. The returns are returned sorted by
 9 |      * creation date, with the most recently created return appearing first.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/order_returns', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Retrieves the details of an existing order return. Supply the unique order ID
25 |      * from either an order return creation request or the order return list, and
26 |      * Stripe will return the corresponding order information.
27 |      *
28 |      * @param string $id
29 |      * @param null|array $params
30 |      * @param null|array|\Stripe\Util\RequestOptions $opts
31 |      *
32 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
33 |      *
34 |      * @return \Stripe\OrderReturn
35 |      */
36 |     public function retrieve($id, $params = null, $opts = null)
37 |     {
38 |         return $this->request('get', $this->buildPath('/v1/order_returns/%s', $id), $params, $opts);
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/lib/ExchangeRate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * <code>Exchange Rate</code> objects allow you to determine the rates that Stripe
 7 |  * is currently using to convert from one currency to another. Since this number is
 8 |  * variable throughout the day, there are various reasons why you might want to
 9 |  * know the current rate (for example, to dynamically price an item for a user with
10 |  * a default payment in a foreign currency).
11 |  *
12 |  * If you want a guarantee that the charge is made with a certain exchange rate you
13 |  * expect is current, you can pass in <code>exchange_rate</code> to charges
14 |  * endpoints. If the value is no longer up to date, the charge won't go through.
15 |  * Please refer to our <a href="https://stripe.com/docs/exchange-rates">Exchange
16 |  * Rates API</a> guide for more details.
17 |  *
18 |  * @property string $id Unique identifier for the object. Represented as the three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a> in lowercase.
19 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
20 |  * @property \Stripe\StripeObject $rates Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
21 |  */
22 | class ExchangeRate extends ApiResource
23 | {
24 |     const OBJECT_NAME = 'exchange_rate';
25 | 
26 |     use ApiOperations\All;
27 |     use ApiOperations\Retrieve;
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/FileLink.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * To share the contents of a <code>File</code> object with non-Stripe users, you
 7 |  * can create a <code>FileLink</code>. <code>FileLink</code>s contain a URL that
 8 |  * can be used to retrieve the contents of the file without authentication.
 9 |  *
10 |  * @property string $id Unique identifier for the object.
11 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
12 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
13 |  * @property bool $expired Whether this link is already expired.
14 |  * @property null|int $expires_at Time at which the link expires.
15 |  * @property string|\Stripe\File $file The file object this link points to.
16 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
17 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
18 |  * @property null|string $url The publicly accessible URL to download the file.
19 |  */
20 | class FileLink extends ApiResource
21 | {
22 |     const OBJECT_NAME = 'file_link';
23 | 
24 |     use ApiOperations\All;
25 |     use ApiOperations\Create;
26 |     use ApiOperations\Retrieve;
27 |     use ApiOperations\Update;
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/Service/EventService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class EventService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * List events, going back up to 30 days. Each event data is rendered according to
 9 |      * Stripe API version at its creation time, specified in <a
10 |      * href="/docs/api/events/object">event object</a> <code>api_version</code>
11 |      * attribute (not according to your current Stripe API version or
12 |      * <code>Stripe-Version</code> header).
13 |      *
14 |      * @param null|array $params
15 |      * @param null|array|\Stripe\Util\RequestOptions $opts
16 |      *
17 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
18 |      *
19 |      * @return \Stripe\Collection
20 |      */
21 |     public function all($params = null, $opts = null)
22 |     {
23 |         return $this->requestCollection('get', '/v1/events', $params, $opts);
24 |     }
25 | 
26 |     /**
27 |      * Retrieves the details of an event. Supply the unique identifier of the event,
28 |      * which you might have received in a webhook.
29 |      *
30 |      * @param string $id
31 |      * @param null|array $params
32 |      * @param null|array|\Stripe\Util\RequestOptions $opts
33 |      *
34 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
35 |      *
36 |      * @return \Stripe\Event
37 |      */
38 |     public function retrieve($id, $params = null, $opts = null)
39 |     {
40 |         return $this->request('get', $this->buildPath('/v1/events/%s', $id), $params, $opts);
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/lib/BillingPortal/Session.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\BillingPortal;
 4 | 
 5 | /**
 6 |  * A session describes the instantiation of the customer portal for a particular
 7 |  * customer. By visiting the session's URL, the customer can manage their
 8 |  * subscriptions and billing details. For security reasons, sessions are
 9 |  * short-lived and will expire if the customer does not visit the URL. Create
10 |  * sessions on-demand when customers intend to manage their subscriptions and
11 |  * billing details.
12 |  *
13 |  * Integration guide: <a
14 |  * href="https://stripe.com/docs/billing/subscriptions/integrating-customer-portal">Billing
15 |  * customer portal</a>.
16 |  *
17 |  * @property string $id Unique identifier for the object.
18 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
19 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
20 |  * @property string $customer The ID of the customer for this session.
21 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
22 |  * @property string $return_url The URL to which Stripe should send customers when they click on the link to return to your website.
23 |  * @property string $url The short-lived URL of the session giving customers access to the customer portal.
24 |  */
25 | class Session extends \Stripe\ApiResource
26 | {
27 |     const OBJECT_NAME = 'billing_portal.session';
28 | 
29 |     use \Stripe\ApiOperations\Create;
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/Update.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for updatable resources. Adds an `update()` static method and a
 7 |  * `save()` method to the class.
 8 |  *
 9 |  * This trait should only be applied to classes that derive from StripeObject.
10 |  */
11 | trait Update
12 | {
13 |     /**
14 |      * @param string $id the ID of the resource to update
15 |      * @param null|array $params
16 |      * @param null|array|string $opts
17 |      *
18 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
19 |      *
20 |      * @return static the updated resource
21 |      */
22 |     public static function update($id, $params = null, $opts = null)
23 |     {
24 |         self::_validateParams($params);
25 |         $url = static::resourceUrl($id);
26 | 
27 |         list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
28 |         $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
29 |         $obj->setLastResponse($response);
30 | 
31 |         return $obj;
32 |     }
33 | 
34 |     /**
35 |      * @param null|array|string $opts
36 |      *
37 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
38 |      *
39 |      * @return static the saved resource
40 |      */
41 |     public function save($opts = null)
42 |     {
43 |         $params = $this->serializeParameters();
44 |         if (\count($params) > 0) {
45 |             $url = $this->instanceUrl();
46 |             list($response, $opts) = $this->_request('post', $url, $params, $opts);
47 |             $this->refreshFrom($response, $opts);
48 |         }
49 | 
50 |         return $this;
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/lib/Webhook.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | abstract class Webhook
 6 | {
 7 |     const DEFAULT_TOLERANCE = 300;
 8 | 
 9 |     /**
10 |      * Returns an Event instance using the provided JSON payload. Throws an
11 |      * Exception\UnexpectedValueException if the payload is not valid JSON, and
12 |      * an Exception\SignatureVerificationException if the signature
13 |      * verification fails for any reason.
14 |      *
15 |      * @param string $payload the payload sent by Stripe
16 |      * @param string $sigHeader the contents of the signature header sent by
17 |      *  Stripe
18 |      * @param string $secret secret used to generate the signature
19 |      * @param int $tolerance maximum difference allowed between the header's
20 |      *  timestamp and the current time
21 |      *
22 |      * @throws Exception\UnexpectedValueException if the payload is not valid JSON,
23 |      * @throws Exception\SignatureVerificationException if the verification fails
24 |      *
25 |      * @return Event the Event instance
26 |      */
27 |     public static function constructEvent($payload, $sigHeader, $secret, $tolerance = self::DEFAULT_TOLERANCE)
28 |     {
29 |         WebhookSignature::verifyHeader($payload, $sigHeader, $secret, $tolerance);
30 | 
31 |         $data = \json_decode($payload, true);
32 |         $jsonError = \json_last_error();
33 |         if (null === $data && \JSON_ERROR_NONE !== $jsonError) {
34 |             $msg = "Invalid payload: {$payload} "
35 |               . "(json_last_error() was {$jsonError})";
36 | 
37 |             throw new Exception\UnexpectedValueException($msg);
38 |         }
39 | 
40 |         return Event::constructFrom($data);
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/lib/StripeClientInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Interface for a Stripe client.
 7 |  */
 8 | interface StripeClientInterface
 9 | {
10 |     /**
11 |      * Gets the API key used by the client to send requests.
12 |      *
13 |      * @return null|string the API key used by the client to send requests
14 |      */
15 |     public function getApiKey();
16 | 
17 |     /**
18 |      * Gets the client ID used by the client in OAuth requests.
19 |      *
20 |      * @return null|string the client ID used by the client in OAuth requests
21 |      */
22 |     public function getClientId();
23 | 
24 |     /**
25 |      * Gets the base URL for Stripe's API.
26 |      *
27 |      * @return string the base URL for Stripe's API
28 |      */
29 |     public function getApiBase();
30 | 
31 |     /**
32 |      * Gets the base URL for Stripe's OAuth API.
33 |      *
34 |      * @return string the base URL for Stripe's OAuth API
35 |      */
36 |     public function getConnectBase();
37 | 
38 |     /**
39 |      * Gets the base URL for Stripe's Files API.
40 |      *
41 |      * @return string the base URL for Stripe's Files API
42 |      */
43 |     public function getFilesBase();
44 | 
45 |     /**
46 |      * Sends a request to Stripe's API.
47 |      *
48 |      * @param string $method the HTTP method
49 |      * @param string $path the path of the request
50 |      * @param array $params the parameters of the request
51 |      * @param array|\Stripe\Util\RequestOptions $opts the special modifiers of the request
52 |      *
53 |      * @return \Stripe\StripeObject the object returned by Stripe's API
54 |      */
55 |     public function request($method, $path, $params, $opts);
56 | }
57 | 


--------------------------------------------------------------------------------
/lib/EphemeralKey.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 9 |  * @property int $expires Time at which the key will expire. Measured in seconds since the Unix epoch.
10 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
11 |  * @property string $secret The key's secret. You can use this value to make authorized requests to the Stripe API.
12 |  * @property array $associated_objects
13 |  */
14 | class EphemeralKey extends ApiResource
15 | {
16 |     const OBJECT_NAME = 'ephemeral_key';
17 | 
18 |     use ApiOperations\Delete;
19 | 
20 |     use ApiOperations\Create {
21 |         create as protected _create;
22 |     }
23 | 
24 |     /**
25 |      * @param null|array $params
26 |      * @param null|array|string $opts
27 |      *
28 |      * @throws \Stripe\Exception\InvalidArgumentException if stripe_version is missing
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\EphemeralKey the created key
32 |      */
33 |     public static function create($params = null, $opts = null)
34 |     {
35 |         if (!$opts || !isset($opts['stripe_version'])) {
36 |             throw new Exception\InvalidArgumentException('stripe_version must be specified to create an ephemeral key');
37 |         }
38 | 
39 |         return self::_create($params, $opts);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/lib/Service/BalanceTransactionService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class BalanceTransactionService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of transactions that have contributed to the Stripe account
 9 |      * balance (e.g., charges, transfers, and so forth). The transactions are returned
10 |      * in sorted order, with the most recent transactions appearing first.
11 |      *
12 |      * Note that this endpoint was previously called “Balance history” and used the
13 |      * path <code>/v1/balance/history</code>.
14 |      *
15 |      * @param null|array $params
16 |      * @param null|array|\Stripe\Util\RequestOptions $opts
17 |      *
18 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
19 |      *
20 |      * @return \Stripe\Collection
21 |      */
22 |     public function all($params = null, $opts = null)
23 |     {
24 |         return $this->requestCollection('get', '/v1/balance_transactions', $params, $opts);
25 |     }
26 | 
27 |     /**
28 |      * Retrieves the balance transaction with the given ID.
29 |      *
30 |      * Note that this endpoint previously used the path
31 |      * <code>/v1/balance/history/:id</code>.
32 |      *
33 |      * @param string $id
34 |      * @param null|array $params
35 |      * @param null|array|\Stripe\Util\RequestOptions $opts
36 |      *
37 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
38 |      *
39 |      * @return \Stripe\BalanceTransaction
40 |      */
41 |     public function retrieve($id, $params = null, $opts = null)
42 |     {
43 |         return $this->request('get', $this->buildPath('/v1/balance_transactions/%s', $id), $params, $opts);
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/lib/Service/AbstractServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | /**
 6 |  * Abstract base class for all service factories used to expose service
 7 |  * instances through {@link \Stripe\StripeClient}.
 8 |  *
 9 |  * Service factories serve two purposes:
10 |  *
11 |  * 1. Expose properties for all services through the `__get()` magic method.
12 |  * 2. Lazily initialize each service instance the first time the property for
13 |  *    a given service is used.
14 |  */
15 | abstract class AbstractServiceFactory
16 | {
17 |     /** @var \Stripe\StripeClientInterface */
18 |     private $client;
19 | 
20 |     /** @var array<string, AbstractService|AbstractServiceFactory> */
21 |     private $services;
22 | 
23 |     /**
24 |      * @param \Stripe\StripeClientInterface $client
25 |      */
26 |     public function __construct($client)
27 |     {
28 |         $this->client = $client;
29 |         $this->services = [];
30 |     }
31 | 
32 |     /**
33 |      * @param string $name
34 |      *
35 |      * @return null|string
36 |      */
37 |     abstract protected function getServiceClass($name);
38 | 
39 |     /**
40 |      * @param string $name
41 |      *
42 |      * @return null|AbstractService|AbstractServiceFactory
43 |      */
44 |     public function __get($name)
45 |     {
46 |         $serviceClass = $this->getServiceClass($name);
47 |         if (null !== $serviceClass) {
48 |             if (!\array_key_exists($name, $this->services)) {
49 |                 $this->services[$name] = new $serviceClass($this->client);
50 |             }
51 | 
52 |             return $this->services[$name];
53 |         }
54 | 
55 |         \trigger_error('Undefined property: ' . static::class . '::$' . $name);
56 | 
57 |         return null;
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/lib/OrderReturn.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * A return represents the full or partial return of a number of <a
 7 |  * href="https://stripe.com/docs/api#order_items">order items</a>. Returns always
 8 |  * belong to an order, and may optionally contain a refund.
 9 |  *
10 |  * Related guide: <a
11 |  * href="https://stripe.com/docs/orders/guide#handling-returns">Handling
12 |  * Returns</a>.
13 |  *
14 |  * @property string $id Unique identifier for the object.
15 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
16 |  * @property int $amount A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.
17 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
19 |  * @property \Stripe\OrderItem[] $items The items included in this order return.
20 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
21 |  * @property null|string|\Stripe\Order $order The order that this return includes items from.
22 |  * @property null|string|\Stripe\Refund $refund The ID of the refund issued for this return.
23 |  */
24 | class OrderReturn extends ApiResource
25 | {
26 |     const OBJECT_NAME = 'order_return';
27 | 
28 |     use ApiOperations\All;
29 |     use ApiOperations\Retrieve;
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Terminal/Reader.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Terminal;
 4 | 
 5 | /**
 6 |  * A Reader represents a physical device for accepting payment details.
 7 |  *
 8 |  * Related guide: <a
 9 |  * href="https://stripe.com/docs/terminal/readers/connecting">Connecting to a
10 |  * Reader</a>.
11 |  *
12 |  * @property string $id Unique identifier for the object.
13 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
14 |  * @property null|string $device_sw_version The current software version of the reader.
15 |  * @property string $device_type Type of reader, one of <code>bbpos_chipper2x</code> or <code>verifone_P400</code>.
16 |  * @property null|string $ip_address The local IP address of the reader.
17 |  * @property string $label Custom label given to the reader for easier identification.
18 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
19 |  * @property null|string $location The location identifier of the reader.
20 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
21 |  * @property string $serial_number Serial number of the reader.
22 |  * @property null|string $status The networking status of the reader.
23 |  */
24 | class Reader extends \Stripe\ApiResource
25 | {
26 |     const OBJECT_NAME = 'terminal.reader';
27 | 
28 |     use \Stripe\ApiOperations\All;
29 |     use \Stripe\ApiOperations\Create;
30 |     use \Stripe\ApiOperations\Delete;
31 |     use \Stripe\ApiOperations\Retrieve;
32 |     use \Stripe\ApiOperations\Update;
33 | }
34 | 


--------------------------------------------------------------------------------
/lib/CountrySpec.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Stripe needs to collect certain pieces of information about each account
 7 |  * created. These requirements can differ depending on the account's country. The
 8 |  * Country Specs API makes these rules available to your integration.
 9 |  *
10 |  * You can also view the information from this API call as <a
11 |  * href="/docs/connect/required-verification-information">an online guide</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object. Represented as the ISO country code for this country.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property string $default_currency The default currency for this country. This applies to both payment methods and bank accounts.
16 |  * @property \Stripe\StripeObject $supported_bank_account_currencies Currencies that can be accepted in the specific country (for transfers).
17 |  * @property string[] $supported_payment_currencies Currencies that can be accepted in the specified country (for payments).
18 |  * @property string[] $supported_payment_methods Payment methods available in the specified country. You may need to enable some payment methods (e.g., <a href="https://stripe.com/docs/ach">ACH</a>) on your account before they appear in this list. The <code>stripe</code> payment method refers to <a href="https://stripe.com/docs/connect/destination-charges">charging through your platform</a>.
19 |  * @property string[] $supported_transfer_countries Countries that can accept transfers from the specified country.
20 |  * @property \Stripe\StripeObject $verification_fields
21 |  */
22 | class CountrySpec extends ApiResource
23 | {
24 |     const OBJECT_NAME = 'country_spec';
25 | 
26 |     use ApiOperations\All;
27 |     use ApiOperations\Retrieve;
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/CreditNoteLineItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property int $amount The integer amount in <strong>%s</strong> representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
 9 |  * @property null|string $description Description of the item being credited.
10 |  * @property int $discount_amount The integer amount in <strong>%s</strong> representing the discount being credited for this line item.
11 |  * @property string $invoice_line_item ID of the invoice line item being credited
12 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
13 |  * @property null|int $quantity The number of units of product being credited.
14 |  * @property \Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
15 |  * @property \Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
16 |  * @property string $type The type of the credit note line item, one of <code>invoice_line_item</code> or <code>custom_line_item</code>. When the type is <code>invoice_line_item</code> there is an additional <code>invoice_line_item</code> property on the resource the value of which is the id of the credited line item on the invoice.
17 |  * @property null|int $unit_amount The cost of each unit of product being credited.
18 |  * @property null|string $unit_amount_decimal Same as <code>unit_amount</code>, but contains a decimal value with at most 12 decimal places.
19 |  */
20 | class CreditNoteLineItem extends ApiResource
21 | {
22 |     const OBJECT_NAME = 'credit_note_line_item';
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/Sigma/ScheduledQueryRun.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Sigma;
 4 | 
 5 | /**
 6 |  * If you have <a href="https://stripe.com/docs/sigma/scheduled-queries">scheduled
 7 |  * a Sigma query</a>, you'll receive a
 8 |  * <code>sigma.scheduled_query_run.created</code> webhook each time the query runs.
 9 |  * The webhook contains a <code>ScheduledQueryRun</code> object, which you can use
10 |  * to retrieve the query results.
11 |  *
12 |  * @property string $id Unique identifier for the object.
13 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
14 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
15 |  * @property int $data_load_time When the query was run, Sigma contained a snapshot of your Stripe data at this time.
16 |  * @property \Stripe\StripeObject $error
17 |  * @property null|\Stripe\File $file The file object representing the results of the query.
18 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
19 |  * @property int $result_available_until Time at which the result expires and is no longer available for download.
20 |  * @property string $sql SQL for the query.
21 |  * @property string $status The query's execution status, which will be <code>completed</code> for successful runs, and <code>canceled</code>, <code>failed</code>, or <code>timed_out</code> otherwise.
22 |  * @property string $title Title of the query.
23 |  */
24 | class ScheduledQueryRun extends \Stripe\ApiResource
25 | {
26 |     const OBJECT_NAME = 'scheduled_query_run';
27 | 
28 |     use \Stripe\ApiOperations\All;
29 |     use \Stripe\ApiOperations\Retrieve;
30 | 
31 |     public static function classUrl()
32 |     {
33 |         return '/v1/sigma/scheduled_query_runs';
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/lib/Exception/InvalidRequestException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * InvalidRequestException is thrown when a request is initiated with invalid
 7 |  * parameters.
 8 |  */
 9 | class InvalidRequestException extends ApiErrorException
10 | {
11 |     protected $stripeParam;
12 | 
13 |     /**
14 |      * Creates a new InvalidRequestException exception.
15 |      *
16 |      * @param string $message the exception message
17 |      * @param null|int $httpStatus the HTTP status code
18 |      * @param null|string $httpBody the HTTP body as a string
19 |      * @param null|array $jsonBody the JSON deserialized body
20 |      * @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array
21 |      * @param null|string $stripeCode the Stripe error code
22 |      * @param null|string $stripeParam the parameter related to the error
23 |      *
24 |      * @return InvalidRequestException
25 |      */
26 |     public static function factory(
27 |         $message,
28 |         $httpStatus = null,
29 |         $httpBody = null,
30 |         $jsonBody = null,
31 |         $httpHeaders = null,
32 |         $stripeCode = null,
33 |         $stripeParam = null
34 |     ) {
35 |         $instance = parent::factory($message, $httpStatus, $httpBody, $jsonBody, $httpHeaders, $stripeCode);
36 |         $instance->setStripeParam($stripeParam);
37 | 
38 |         return $instance;
39 |     }
40 | 
41 |     /**
42 |      * Gets the parameter related to the error.
43 |      *
44 |      * @return null|string
45 |      */
46 |     public function getStripeParam()
47 |     {
48 |         return $this->stripeParam;
49 |     }
50 | 
51 |     /**
52 |      * Sets the parameter related to the error.
53 |      *
54 |      * @param null|string $stripeParam
55 |      */
56 |     public function setStripeParam($stripeParam)
57 |     {
58 |         $this->stripeParam = $stripeParam;
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/lib/Radar/ValueList.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Radar;
 4 | 
 5 | /**
 6 |  * Value lists allow you to group values together which can then be referenced in
 7 |  * rules.
 8 |  *
 9 |  * Related guide: <a
10 |  * href="https://stripe.com/docs/radar/lists#managing-list-items">Default Stripe
11 |  * Lists</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property string $alias The name of the value list for use in rules.
16 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
17 |  * @property string $created_by The name or email address of the user who created this value list.
18 |  * @property string $item_type The type of items in the value list. One of <code>card_fingerprint</code>, <code>card_bin</code>, <code>email</code>, <code>ip_address</code>, <code>country</code>, <code>string</code>, or <code>case_sensitive_string</code>.
19 |  * @property \Stripe\Collection $list_items List of items contained within this value list.
20 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
21 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
22 |  * @property string $name The name of the value list.
23 |  */
24 | class ValueList extends \Stripe\ApiResource
25 | {
26 |     const OBJECT_NAME = 'radar.value_list';
27 | 
28 |     use \Stripe\ApiOperations\All;
29 |     use \Stripe\ApiOperations\Create;
30 |     use \Stripe\ApiOperations\Delete;
31 |     use \Stripe\ApiOperations\Retrieve;
32 |     use \Stripe\ApiOperations\Update;
33 | }
34 | 


--------------------------------------------------------------------------------
/lib/Service/ReviewService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class ReviewService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of <code>Review</code> objects that have <code>open</code> set to
 9 |      * <code>true</code>. The objects are sorted in descending order by creation date,
10 |      * with the most recently created object appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/reviews', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Approves a <code>Review</code> object, closing it and removing it from the list
26 |      * of reviews.
27 |      *
28 |      * @param string $id
29 |      * @param null|array $params
30 |      * @param null|array|\Stripe\Util\RequestOptions $opts
31 |      *
32 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
33 |      *
34 |      * @return \Stripe\Review
35 |      */
36 |     public function approve($id, $params = null, $opts = null)
37 |     {
38 |         return $this->request('post', $this->buildPath('/v1/reviews/%s/approve', $id), $params, $opts);
39 |     }
40 | 
41 |     /**
42 |      * Retrieves a <code>Review</code> object.
43 |      *
44 |      * @param string $id
45 |      * @param null|array $params
46 |      * @param null|array|\Stripe\Util\RequestOptions $opts
47 |      *
48 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
49 |      *
50 |      * @return \Stripe\Review
51 |      */
52 |     public function retrieve($id, $params = null, $opts = null)
53 |     {
54 |         return $this->request('get', $this->buildPath('/v1/reviews/%s', $id), $params, $opts);
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/lib/TaxRate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Tax rates can be applied to invoices and subscriptions to collect tax.
 7 |  *
 8 |  * Related guide: <a href="https://stripe.com/docs/billing/taxes/tax-rates">Tax
 9 |  * Rates</a>.
10 |  *
11 |  * @property string $id Unique identifier for the object.
12 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
13 |  * @property bool $active Defaults to <code>true</code>. When set to <code>false</code>, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set.
14 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
15 |  * @property null|string $description An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
16 |  * @property string $display_name The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
17 |  * @property bool $inclusive This specifies if the tax rate is inclusive or exclusive.
18 |  * @property null|string $jurisdiction The jurisdiction for the tax rate.
19 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
20 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
21 |  * @property float $percentage This represents the tax rate percent out of 100.
22 |  */
23 | class TaxRate extends ApiResource
24 | {
25 |     const OBJECT_NAME = 'tax_rate';
26 | 
27 |     use ApiOperations\All;
28 |     use ApiOperations\Create;
29 |     use ApiOperations\Retrieve;
30 |     use ApiOperations\Update;
31 | }
32 | 


--------------------------------------------------------------------------------
/lib/Exception/SignatureVerificationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * SignatureVerificationException is thrown when the signature verification for
 7 |  * a webhook fails.
 8 |  */
 9 | class SignatureVerificationException extends \Exception implements ExceptionInterface
10 | {
11 |     protected $httpBody;
12 |     protected $sigHeader;
13 | 
14 |     /**
15 |      * Creates a new SignatureVerificationException exception.
16 |      *
17 |      * @param string $message the exception message
18 |      * @param null|string $httpBody the HTTP body as a string
19 |      * @param null|string $sigHeader the `Stripe-Signature` HTTP header
20 |      *
21 |      * @return SignatureVerificationException
22 |      */
23 |     public static function factory(
24 |         $message,
25 |         $httpBody = null,
26 |         $sigHeader = null
27 |     ) {
28 |         $instance = new static($message);
29 |         $instance->setHttpBody($httpBody);
30 |         $instance->setSigHeader($sigHeader);
31 | 
32 |         return $instance;
33 |     }
34 | 
35 |     /**
36 |      * Gets the HTTP body as a string.
37 |      *
38 |      * @return null|string
39 |      */
40 |     public function getHttpBody()
41 |     {
42 |         return $this->httpBody;
43 |     }
44 | 
45 |     /**
46 |      * Sets the HTTP body as a string.
47 |      *
48 |      * @param null|string $httpBody
49 |      */
50 |     public function setHttpBody($httpBody)
51 |     {
52 |         $this->httpBody = $httpBody;
53 |     }
54 | 
55 |     /**
56 |      * Gets the `Stripe-Signature` HTTP header.
57 |      *
58 |      * @return null|string
59 |      */
60 |     public function getSigHeader()
61 |     {
62 |         return $this->sigHeader;
63 |     }
64 | 
65 |     /**
66 |      * Sets the `Stripe-Signature` HTTP header.
67 |      *
68 |      * @param null|string $sigHeader
69 |      */
70 |     public function setSigHeader($sigHeader)
71 |     {
72 |         $this->sigHeader = $sigHeader;
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/lib/LineItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Checkout Session line item.
 7 |  *
 8 |  * @property string $id Unique identifier for the object.
 9 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
10 |  * @property null|int $amount_subtotal Total before any discounts or taxes is applied.
11 |  * @property null|int $amount_total Total after discounts and taxes.
12 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
13 |  * @property string $description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
14 |  * @property \Stripe\Price $price <p>Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. <a href="https://stripe.com/docs/api#products">Products</a> help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.</p><p>For example, you might have a single &quot;gold&quot; product that has prices for $10/month, $100/year, and €9 once.</p><p>Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>, <a href="https://stripe.com/docs/billing/invoices/create">create an invoice</a>, and more about <a href="https://stripe.com/docs/billing/prices-guide">products and prices</a>.</p>
15 |  * @property null|int $quantity The quantity of products being purchased.
16 |  * @property \Stripe\StripeObject[] $taxes The taxes applied to the line item.
17 |  */
18 | class LineItem extends ApiResource
19 | {
20 |     const OBJECT_NAME = 'item';
21 | 
22 |     use ApiOperations\All;
23 | }
24 | 


--------------------------------------------------------------------------------
/lib/Service/Reporting/ReportRunService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Reporting;
 4 | 
 5 | class ReportRunService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Report Runs, with the most recent appearing first. (Requires a
 9 |      * <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/reporting/report_runs', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates a new object and begin running the report. (Requires a <a
25 |      * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
26 |      *
27 |      * @param null|array $params
28 |      * @param null|array|\Stripe\Util\RequestOptions $opts
29 |      *
30 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
31 |      *
32 |      * @return \Stripe\Reporting\ReportRun
33 |      */
34 |     public function create($params = null, $opts = null)
35 |     {
36 |         return $this->request('post', '/v1/reporting/report_runs', $params, $opts);
37 |     }
38 | 
39 |     /**
40 |      * Retrieves the details of an existing Report Run. (Requires a <a
41 |      * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.).
42 |      *
43 |      * @param string $id
44 |      * @param null|array $params
45 |      * @param null|array|\Stripe\Util\RequestOptions $opts
46 |      *
47 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
48 |      *
49 |      * @return \Stripe\Reporting\ReportRun
50 |      */
51 |     public function retrieve($id, $params = null, $opts = null)
52 |     {
53 |         return $this->request('get', $this->buildPath('/v1/reporting/report_runs/%s', $id), $params, $opts);
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/lib/Service/Issuing/TransactionService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Issuing;
 4 | 
 5 | class TransactionService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Issuing <code>Transaction</code> objects. The objects are
 9 |      * sorted in descending order by creation date, with the most recently created
10 |      * object appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/issuing/transactions', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Retrieves an Issuing <code>Transaction</code> object.
26 |      *
27 |      * @param string $id
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\Issuing\Transaction
34 |      */
35 |     public function retrieve($id, $params = null, $opts = null)
36 |     {
37 |         return $this->request('get', $this->buildPath('/v1/issuing/transactions/%s', $id), $params, $opts);
38 |     }
39 | 
40 |     /**
41 |      * Updates the specified Issuing <code>Transaction</code> object by setting the
42 |      * values of the parameters passed. Any parameters not provided will be left
43 |      * unchanged.
44 |      *
45 |      * @param string $id
46 |      * @param null|array $params
47 |      * @param null|array|\Stripe\Util\RequestOptions $opts
48 |      *
49 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
50 |      *
51 |      * @return \Stripe\Issuing\Transaction
52 |      */
53 |     public function update($id, $params = null, $opts = null)
54 |     {
55 |         return $this->request('post', $this->buildPath('/v1/issuing/transactions/%s', $id), $params, $opts);
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/lib/Reporting/ReportType.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Reporting;
 4 | 
 5 | /**
 6 |  * The Report Type resource corresponds to a particular type of report, such as the
 7 |  * &quot;Activity summary&quot; or &quot;Itemized payouts&quot; reports. These
 8 |  * objects are identified by an ID belonging to a set of enumerated values. See <a
 9 |  * href="https://stripe.com/docs/reporting/statements/api">API Access to Reports
10 |  * documentation</a> for those Report Type IDs, along with required and optional
11 |  * parameters.
12 |  *
13 |  * Note that reports can only be run based on your live-mode data (not test-mode
14 |  * data), and thus related requests must be made with a <a
15 |  * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.
16 |  *
17 |  * @property string $id The <a href="https://stripe.com/docs/reporting/statements/api#available-report-types">ID of the Report Type</a>, such as <code>balance.summary.1</code>.
18 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
19 |  * @property int $data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
20 |  * @property int $data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
21 |  * @property null|string[] $default_columns List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the <code>columns</code> parameter, this will be null.)
22 |  * @property string $name Human-readable name of the Report Type
23 |  * @property int $updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.
24 |  * @property int $version Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
25 |  */
26 | class ReportType extends \Stripe\ApiResource
27 | {
28 |     const OBJECT_NAME = 'reporting.report_type';
29 | 
30 |     use \Stripe\ApiOperations\All;
31 |     use \Stripe\ApiOperations\Retrieve;
32 | }
33 | 


--------------------------------------------------------------------------------
/lib/Util/CaseInsensitiveArray.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Util;
 4 | 
 5 | /**
 6 |  * CaseInsensitiveArray is an array-like class that ignores case for keys.
 7 |  *
 8 |  * It is used to store HTTP headers. Per RFC 2616, section 4.2:
 9 |  * Each header field consists of a name followed by a colon (":") and the field value. Field names
10 |  * are case-insensitive.
11 |  *
12 |  * In the context of stripe-php, this is useful because the API will return headers with different
13 |  * case depending on whether HTTP/2 is used or not (with HTTP/2, headers are always in lowercase).
14 |  */
15 | class CaseInsensitiveArray implements \ArrayAccess, \Countable, \IteratorAggregate
16 | {
17 |     private $container = [];
18 | 
19 |     public function __construct($initial_array = [])
20 |     {
21 |         $this->container = \array_change_key_case($initial_array, \CASE_LOWER);
22 |     }
23 | 
24 |     public function count()
25 |     {
26 |         return \count($this->container);
27 |     }
28 | 
29 |     public function getIterator()
30 |     {
31 |         return new \ArrayIterator($this->container);
32 |     }
33 | 
34 |     public function offsetSet($offset, $value)
35 |     {
36 |         $offset = static::maybeLowercase($offset);
37 |         if (null === $offset) {
38 |             $this->container[] = $value;
39 |         } else {
40 |             $this->container[$offset] = $value;
41 |         }
42 |     }
43 | 
44 |     public function offsetExists($offset)
45 |     {
46 |         $offset = static::maybeLowercase($offset);
47 | 
48 |         return isset($this->container[$offset]);
49 |     }
50 | 
51 |     public function offsetUnset($offset)
52 |     {
53 |         $offset = static::maybeLowercase($offset);
54 |         unset($this->container[$offset]);
55 |     }
56 | 
57 |     public function offsetGet($offset)
58 |     {
59 |         $offset = static::maybeLowercase($offset);
60 | 
61 |         return isset($this->container[$offset]) ? $this->container[$offset] : null;
62 |     }
63 | 
64 |     private static function maybeLowercase($v)
65 |     {
66 |         if (\is_string($v)) {
67 |             return \strtolower($v);
68 |         }
69 | 
70 |         return $v;
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/lib/Radar/EarlyFraudWarning.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Radar;
 4 | 
 5 | /**
 6 |  * An early fraud warning indicates that the card issuer has notified us that a
 7 |  * charge may be fraudulent.
 8 |  *
 9 |  * Related guide: <a
10 |  * href="https://stripe.com/docs/disputes/measuring#early-fraud-warnings">Early
11 |  * Fraud Warnings</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property bool $actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
16 |  * @property string|\Stripe\Charge $charge ID of the charge this early fraud warning is for, optionally expanded.
17 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18 |  * @property string $fraud_type The type of fraud labelled by the issuer. One of <code>card_never_received</code>, <code>fraudulent_card_application</code>, <code>made_with_counterfeit_card</code>, <code>made_with_lost_card</code>, <code>made_with_stolen_card</code>, <code>misc</code>, <code>unauthorized_use_of_card</code>.
19 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
20 |  */
21 | class EarlyFraudWarning extends \Stripe\ApiResource
22 | {
23 |     const OBJECT_NAME = 'radar.early_fraud_warning';
24 | 
25 |     use \Stripe\ApiOperations\All;
26 |     use \Stripe\ApiOperations\Retrieve;
27 | 
28 |     const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received';
29 |     const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application';
30 |     const FRAUD_TYPE_MADE_WITH_COUNTERFEIT_CARD = 'made_with_counterfeit_card';
31 |     const FRAUD_TYPE_MADE_WITH_LOST_CARD = 'made_with_lost_card';
32 |     const FRAUD_TYPE_MADE_WITH_STOLEN_CARD = 'made_with_stolen_card';
33 |     const FRAUD_TYPE_MISC = 'misc';
34 |     const FRAUD_TYPE_UNAUTHORIZED_USE_OF_CARD = 'unauthorized_use_of_card';
35 | }
36 | 


--------------------------------------------------------------------------------
/lib/Service/ApplePayDomainService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class ApplePayDomainService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * List apple pay domains.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/apple_pay/domains', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Create an apple pay domain.
24 |      *
25 |      * @param null|array $params
26 |      * @param null|array|\Stripe\Util\RequestOptions $opts
27 |      *
28 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
29 |      *
30 |      * @return \Stripe\ApplePayDomain
31 |      */
32 |     public function create($params = null, $opts = null)
33 |     {
34 |         return $this->request('post', '/v1/apple_pay/domains', $params, $opts);
35 |     }
36 | 
37 |     /**
38 |      * Delete an apple pay domain.
39 |      *
40 |      * @param string $id
41 |      * @param null|array $params
42 |      * @param null|array|\Stripe\Util\RequestOptions $opts
43 |      *
44 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
45 |      *
46 |      * @return \Stripe\ApplePayDomain
47 |      */
48 |     public function delete($id, $params = null, $opts = null)
49 |     {
50 |         return $this->request('delete', $this->buildPath('/v1/apple_pay/domains/%s', $id), $params, $opts);
51 |     }
52 | 
53 |     /**
54 |      * Retrieve an apple pay domain.
55 |      *
56 |      * @param string $id
57 |      * @param null|array $params
58 |      * @param null|array|\Stripe\Util\RequestOptions $opts
59 |      *
60 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
61 |      *
62 |      * @return \Stripe\ApplePayDomain
63 |      */
64 |     public function retrieve($id, $params = null, $opts = null)
65 |     {
66 |         return $this->request('get', $this->buildPath('/v1/apple_pay/domains/%s', $id), $params, $opts);
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/lib/Service/FileLinkService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class FileLinkService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of file links.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/file_links', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Creates a new file link object.
24 |      *
25 |      * @param null|array $params
26 |      * @param null|array|\Stripe\Util\RequestOptions $opts
27 |      *
28 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
29 |      *
30 |      * @return \Stripe\FileLink
31 |      */
32 |     public function create($params = null, $opts = null)
33 |     {
34 |         return $this->request('post', '/v1/file_links', $params, $opts);
35 |     }
36 | 
37 |     /**
38 |      * Retrieves the file link with the given ID.
39 |      *
40 |      * @param string $id
41 |      * @param null|array $params
42 |      * @param null|array|\Stripe\Util\RequestOptions $opts
43 |      *
44 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
45 |      *
46 |      * @return \Stripe\FileLink
47 |      */
48 |     public function retrieve($id, $params = null, $opts = null)
49 |     {
50 |         return $this->request('get', $this->buildPath('/v1/file_links/%s', $id), $params, $opts);
51 |     }
52 | 
53 |     /**
54 |      * Updates an existing file link object. Expired links can no longer be updated.
55 |      *
56 |      * @param string $id
57 |      * @param null|array $params
58 |      * @param null|array|\Stripe\Util\RequestOptions $opts
59 |      *
60 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
61 |      *
62 |      * @return \Stripe\FileLink
63 |      */
64 |     public function update($id, $params = null, $opts = null)
65 |     {
66 |         return $this->request('post', $this->buildPath('/v1/file_links/%s', $id), $params, $opts);
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/lib/Service/TaxRateService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class TaxRateService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your tax rates. Tax rates are returned sorted by creation
 9 |      * date, with the most recently created tax rates appearing first.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/tax_rates', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates a new tax rate.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\TaxRate
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         return $this->request('post', '/v1/tax_rates', $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Retrieves a tax rate with the given ID.
40 |      *
41 |      * @param string $id
42 |      * @param null|array $params
43 |      * @param null|array|\Stripe\Util\RequestOptions $opts
44 |      *
45 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
46 |      *
47 |      * @return \Stripe\TaxRate
48 |      */
49 |     public function retrieve($id, $params = null, $opts = null)
50 |     {
51 |         return $this->request('get', $this->buildPath('/v1/tax_rates/%s', $id), $params, $opts);
52 |     }
53 | 
54 |     /**
55 |      * Updates an existing tax rate.
56 |      *
57 |      * @param string $id
58 |      * @param null|array $params
59 |      * @param null|array|\Stripe\Util\RequestOptions $opts
60 |      *
61 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
62 |      *
63 |      * @return \Stripe\TaxRate
64 |      */
65 |     public function update($id, $params = null, $opts = null)
66 |     {
67 |         return $this->request('post', $this->buildPath('/v1/tax_rates/%s', $id), $params, $opts);
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/lib/Service/FileService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class FileService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of the files that your account has access to. The files are
 9 |      * returned sorted by creation date, with the most recently created files appearing
10 |      * first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/files', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Retrieves the details of an existing file object. Supply the unique file ID from
26 |      * a file, and Stripe will return the corresponding file object. To access file
27 |      * contents, see the <a href="/docs/file-upload#download-file-contents">File Upload
28 |      * Guide</a>.
29 |      *
30 |      * @param string $id
31 |      * @param null|array $params
32 |      * @param null|array|\Stripe\Util\RequestOptions $opts
33 |      *
34 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
35 |      *
36 |      * @return \Stripe\File
37 |      */
38 |     public function retrieve($id, $params = null, $opts = null)
39 |     {
40 |         return $this->request('get', $this->buildPath('/v1/files/%s', $id), $params, $opts);
41 |     }
42 | 
43 |     /**
44 |      * Create a file.
45 |      *
46 |      * @param null|array $params
47 |      * @param null|array|\Stripe\Util\RequestOptions $opts
48 |      *
49 |      * @return \Stripe\File
50 |      */
51 |     public function create($params = null, $opts = null)
52 |     {
53 |         $opts = \Stripe\Util\RequestOptions::parse($opts);
54 |         if (!isset($opts->apiBase)) {
55 |             $opts->apiBase = $this->getClient()->getFilesBase();
56 |         }
57 | 
58 |         // Manually flatten params, otherwise curl's multipart encoder will
59 |         // choke on nested null|arrays.
60 |         $flatParams = \array_column(\Stripe\Util\Util::flattenParams($params), 1, 0);
61 | 
62 |         return $this->request('post', '/v1/files', $flatParams, $opts);
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/lib/Service/PriceService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class PriceService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your prices.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/prices', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Creates a new price for an existing product. The price can be recurring or
24 |      * one-time.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\Price
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         return $this->request('post', '/v1/prices', $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Retrieves the price with the given ID.
40 |      *
41 |      * @param string $id
42 |      * @param null|array $params
43 |      * @param null|array|\Stripe\Util\RequestOptions $opts
44 |      *
45 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
46 |      *
47 |      * @return \Stripe\Price
48 |      */
49 |     public function retrieve($id, $params = null, $opts = null)
50 |     {
51 |         return $this->request('get', $this->buildPath('/v1/prices/%s', $id), $params, $opts);
52 |     }
53 | 
54 |     /**
55 |      * Updates the specified price by setting the values of the parameters passed. Any
56 |      * parameters not provided are left unchanged.
57 |      *
58 |      * @param string $id
59 |      * @param null|array $params
60 |      * @param null|array|\Stripe\Util\RequestOptions $opts
61 |      *
62 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
63 |      *
64 |      * @return \Stripe\Price
65 |      */
66 |     public function update($id, $params = null, $opts = null)
67 |     {
68 |         return $this->request('post', $this->buildPath('/v1/prices/%s', $id), $params, $opts);
69 |     }
70 | }
71 | 


--------------------------------------------------------------------------------
/lib/Service/AbstractService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | /**
 6 |  * Abstract base class for all services.
 7 |  */
 8 | abstract class AbstractService
 9 | {
10 |     /**
11 |      * @var \Stripe\StripeClientInterface
12 |      */
13 |     protected $client;
14 | 
15 |     /**
16 |      * Initializes a new instance of the {@link AbstractService} class.
17 |      *
18 |      * @param \Stripe\StripeClientInterface $client
19 |      */
20 |     public function __construct($client)
21 |     {
22 |         $this->client = $client;
23 |     }
24 | 
25 |     /**
26 |      * Gets the client used by this service to send requests.
27 |      *
28 |      * @return \Stripe\StripeClientInterface
29 |      */
30 |     public function getClient()
31 |     {
32 |         return $this->client;
33 |     }
34 | 
35 |     /**
36 |      * Translate null values to empty strings. For service methods,
37 |      * we interpret null as a request to unset the field, which
38 |      * corresponds to sending an empty string for the field to the
39 |      * API.
40 |      *
41 |      * @param null|array $params
42 |      */
43 |     private static function formatParams($params)
44 |     {
45 |         if (null === $params) {
46 |             return null;
47 |         }
48 |         \array_walk_recursive($params, function (&$value, $key) {
49 |             if (null === $value) {
50 |                 $value = '';
51 |             }
52 |         });
53 | 
54 |         return $params;
55 |     }
56 | 
57 |     protected function request($method, $path, $params, $opts)
58 |     {
59 |         return $this->getClient()->request($method, $path, static::formatParams($params), $opts);
60 |     }
61 | 
62 |     protected function requestCollection($method, $path, $params, $opts)
63 |     {
64 |         return $this->getClient()->requestCollection($method, $path, static::formatParams($params), $opts);
65 |     }
66 | 
67 |     protected function buildPath($basePath, ...$ids)
68 |     {
69 |         foreach ($ids as $id) {
70 |             if (null === $id || '' === \trim($id)) {
71 |                 $msg = 'The resource ID cannot be null or whitespace.';
72 | 
73 |                 throw new \Stripe\Exception\InvalidArgumentException($msg);
74 |             }
75 |         }
76 | 
77 |         return \sprintf($basePath, ...\array_map('\urlencode', $ids));
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/lib/Balance.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * This is an object representing your Stripe balance. You can retrieve it to see
 7 |  * the balance currently on your Stripe account.
 8 |  *
 9 |  * You can also retrieve the balance history, which contains a list of <a
10 |  * href="https://stripe.com/docs/reporting/balance-transaction-types">transactions</a>
11 |  * that contributed to the balance (charges, payouts, and so forth).
12 |  *
13 |  * The available and pending amounts for each currency are broken down further by
14 |  * payment source types.
15 |  *
16 |  * Related guide: <a
17 |  * href="https://stripe.com/docs/connect/account-balances">Understanding Connect
18 |  * Account Balances</a>.
19 |  *
20 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
21 |  * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the <a href="https://stripe.com/docs/api#transfers">Transfers API</a> or <a href="https://stripe.com/docs/api#payouts">Payouts API</a>. The available balance for each currency and payment type can be found in the <code>source_types</code> property.
22 |  * @property \Stripe\StripeObject[] $connect_reserved Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the <code>source_types</code> property.
23 |  * @property \Stripe\StripeObject $issuing
24 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
25 |  * @property \Stripe\StripeObject[] $pending Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the <code>source_types</code> property.
26 |  */
27 | class Balance extends SingletonApiResource
28 | {
29 |     const OBJECT_NAME = 'balance';
30 | 
31 |     /**
32 |      * @param null|array|string $opts
33 |      *
34 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
35 |      *
36 |      * @return \Stripe\Balance
37 |      */
38 |     public static function retrieve($opts = null)
39 |     {
40 |         return self::_singletonRetrieve($opts);
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/lib/Issuing/Cardholder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Issuing;
 4 | 
 5 | /**
 6 |  * An Issuing <code>Cardholder</code> object represents an individual or business
 7 |  * entity who is <a href="https://stripe.com/docs/issuing">issued</a> cards.
 8 |  *
 9 |  * Related guide: <a
10 |  * href="https://stripe.com/docs/issuing/cards#create-cardholder">How to create a
11 |  * Cardholder</a>
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property \Stripe\StripeObject $billing
16 |  * @property null|\Stripe\StripeObject $company Additional information about a <code>company</code> cardholder.
17 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18 |  * @property null|string $email The cardholder's email address.
19 |  * @property null|\Stripe\StripeObject $individual Additional information about an <code>individual</code> cardholder.
20 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
21 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
22 |  * @property string $name The cardholder's name. This will be printed on cards issued to them.
23 |  * @property null|string $phone_number The cardholder's phone number.
24 |  * @property \Stripe\StripeObject $requirements
25 |  * @property null|\Stripe\StripeObject $spending_controls Spending rules that give you some control over how this cardholder's cards can be used. Refer to our <a href="https://stripe.com/docs/issuing/purchases/authorizations">authorizations</a> documentation for more details.
26 |  * @property string $status Specifies whether to permit authorizations on this cardholder's cards.
27 |  * @property string $type One of <code>individual</code> or <code>company</code>.
28 |  */
29 | class Cardholder extends \Stripe\ApiResource
30 | {
31 |     const OBJECT_NAME = 'issuing.cardholder';
32 | 
33 |     use \Stripe\ApiOperations\All;
34 |     use \Stripe\ApiOperations\Create;
35 |     use \Stripe\ApiOperations\Retrieve;
36 |     use \Stripe\ApiOperations\Update;
37 | }
38 | 


--------------------------------------------------------------------------------
/lib/WebhookEndpoint.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * You can configure <a href="https://stripe.com/docs/webhooks/">webhook
 7 |  * endpoints</a> via the API to be notified about events that happen in your Stripe
 8 |  * account or connected accounts.
 9 |  *
10 |  * Most users configure webhooks from <a
11 |  * href="https://dashboard.stripe.com/webhooks">the dashboard</a>, which provides a
12 |  * user interface for registering and testing your webhook endpoints.
13 |  *
14 |  * Related guide: <a href="https://stripe.com/docs/webhooks/configure">Setting up
15 |  * Webhooks</a>.
16 |  *
17 |  * @property string $id Unique identifier for the object.
18 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
19 |  * @property null|string $api_version The API version events are rendered as for this webhook endpoint.
20 |  * @property null|string $application The ID of the associated Connect application.
21 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
22 |  * @property null|string $description An optional description of what the wehbook is used for.
23 |  * @property string[] $enabled_events The list of events to enable for this endpoint. <code>['*']</code> indicates that all events are enabled, except those that require explicit selection.
24 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
25 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
26 |  * @property string $secret The endpoint's secret, used to generate <a href="https://stripe.com/docs/webhooks/signatures">webhook signatures</a>. Only returned at creation.
27 |  * @property string $status The status of the webhook. It can be <code>enabled</code> or <code>disabled</code>.
28 |  * @property string $url The URL of the webhook endpoint.
29 |  */
30 | class WebhookEndpoint extends ApiResource
31 | {
32 |     const OBJECT_NAME = 'webhook_endpoint';
33 | 
34 |     use ApiOperations\All;
35 |     use ApiOperations\Create;
36 |     use ApiOperations\Delete;
37 |     use ApiOperations\Retrieve;
38 |     use ApiOperations\Update;
39 | }
40 | 


--------------------------------------------------------------------------------
/lib/Reporting/ReportRun.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Reporting;
 4 | 
 5 | /**
 6 |  * The Report Run object represents an instance of a report type generated with
 7 |  * specific run parameters. Once the object is created, Stripe begins processing
 8 |  * the report. When the report has finished running, it will give you a reference
 9 |  * to a file where you can retrieve your results. For an overview, see <a
10 |  * href="https://stripe.com/docs/reporting/statements/api">API Access to
11 |  * Reports</a>.
12 |  *
13 |  * Note that reports can only be run based on your live-mode data (not test-mode
14 |  * data), and thus related requests must be made with a <a
15 |  * href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.
16 |  *
17 |  * @property string $id Unique identifier for the object.
18 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
19 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
20 |  * @property null|string $error If something should go wrong during the run, a message about the failure (populated when <code>status=failed</code>).
21 |  * @property bool $livemode Always <code>true</code>: reports can only be run on live-mode data.
22 |  * @property \Stripe\StripeObject $parameters
23 |  * @property string $report_type The ID of the <a href="https://stripe.com/docs/reporting/statements/api#report-types">report type</a> to run, such as <code>&quot;balance.summary.1&quot;</code>.
24 |  * @property null|\Stripe\File $result The file object representing the result of the report run (populated when <code>status=succeeded</code>).
25 |  * @property string $status Status of this report run. This will be <code>pending</code> when the run is initially created. When the run finishes, this will be set to <code>succeeded</code> and the <code>result</code> field will be populated. Rarely, we may encounter an error, at which point this will be set to <code>failed</code> and the <code>error</code> field will be populated.
26 |  * @property null|int $succeeded_at Timestamp at which this run successfully finished (populated when <code>status=succeeded</code>). Measured in seconds since the Unix epoch.
27 |  */
28 | class ReportRun extends \Stripe\ApiResource
29 | {
30 |     const OBJECT_NAME = 'reporting.report_run';
31 | 
32 |     use \Stripe\ApiOperations\All;
33 |     use \Stripe\ApiOperations\Create;
34 |     use \Stripe\ApiOperations\Retrieve;
35 | }
36 | 


--------------------------------------------------------------------------------
/lib/Exception/CardException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Exception;
 4 | 
 5 | /**
 6 |  * CardException is thrown when a user enters a card that can't be charged for
 7 |  * some reason.
 8 |  */
 9 | class CardException extends ApiErrorException
10 | {
11 |     protected $declineCode;
12 |     protected $stripeParam;
13 | 
14 |     /**
15 |      * Creates a new CardException exception.
16 |      *
17 |      * @param string $message the exception message
18 |      * @param null|int $httpStatus the HTTP status code
19 |      * @param null|string $httpBody the HTTP body as a string
20 |      * @param null|array $jsonBody the JSON deserialized body
21 |      * @param null|array|\Stripe\Util\CaseInsensitiveArray $httpHeaders the HTTP headers array
22 |      * @param null|string $stripeCode the Stripe error code
23 |      * @param null|string $declineCode the decline code
24 |      * @param null|string $stripeParam the parameter related to the error
25 |      *
26 |      * @return CardException
27 |      */
28 |     public static function factory(
29 |         $message,
30 |         $httpStatus = null,
31 |         $httpBody = null,
32 |         $jsonBody = null,
33 |         $httpHeaders = null,
34 |         $stripeCode = null,
35 |         $declineCode = null,
36 |         $stripeParam = null
37 |     ) {
38 |         $instance = parent::factory($message, $httpStatus, $httpBody, $jsonBody, $httpHeaders, $stripeCode);
39 |         $instance->setDeclineCode($declineCode);
40 |         $instance->setStripeParam($stripeParam);
41 | 
42 |         return $instance;
43 |     }
44 | 
45 |     /**
46 |      * Gets the decline code.
47 |      *
48 |      * @return null|string
49 |      */
50 |     public function getDeclineCode()
51 |     {
52 |         return $this->declineCode;
53 |     }
54 | 
55 |     /**
56 |      * Sets the decline code.
57 |      *
58 |      * @param null|string $declineCode
59 |      */
60 |     public function setDeclineCode($declineCode)
61 |     {
62 |         $this->declineCode = $declineCode;
63 |     }
64 | 
65 |     /**
66 |      * Gets the parameter related to the error.
67 |      *
68 |      * @return null|string
69 |      */
70 |     public function getStripeParam()
71 |     {
72 |         return $this->stripeParam;
73 |     }
74 | 
75 |     /**
76 |      * Sets the parameter related to the error.
77 |      *
78 |      * @param null|string $stripeParam
79 |      */
80 |     public function setStripeParam($stripeParam)
81 |     {
82 |         $this->stripeParam = $stripeParam;
83 |     }
84 | }
85 | 


--------------------------------------------------------------------------------
/lib/Service/Checkout/SessionService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Checkout;
 4 | 
 5 | class SessionService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Checkout Sessions.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/checkout/sessions', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * When retrieving a Checkout Session, there is an includable
24 |      * <strong>line_items</strong> property containing the first handful of those
25 |      * items. There is also a URL where you can retrieve the full (paginated) list of
26 |      * line items.
27 |      *
28 |      * @param string $parentId
29 |      * @param null|array $params
30 |      * @param null|array|\Stripe\Util\RequestOptions $opts
31 |      *
32 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
33 |      *
34 |      * @return \Stripe\Collection
35 |      */
36 |     public function allLineItems($parentId, $params = null, $opts = null)
37 |     {
38 |         return $this->requestCollection('get', $this->buildPath('/v1/checkout/sessions/%s/line_items', $parentId), $params, $opts);
39 |     }
40 | 
41 |     /**
42 |      * Creates a Session object.
43 |      *
44 |      * @param null|array $params
45 |      * @param null|array|\Stripe\Util\RequestOptions $opts
46 |      *
47 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
48 |      *
49 |      * @return \Stripe\Checkout\Session
50 |      */
51 |     public function create($params = null, $opts = null)
52 |     {
53 |         return $this->request('post', '/v1/checkout/sessions', $params, $opts);
54 |     }
55 | 
56 |     /**
57 |      * Retrieves a Session object.
58 |      *
59 |      * @param string $id
60 |      * @param null|array $params
61 |      * @param null|array|\Stripe\Util\RequestOptions $opts
62 |      *
63 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
64 |      *
65 |      * @return \Stripe\Checkout\Session
66 |      */
67 |     public function retrieve($id, $params = null, $opts = null)
68 |     {
69 |         return $this->request('get', $this->buildPath('/v1/checkout/sessions/%s', $id), $params, $opts);
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/lib/Service/Issuing/CardService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Issuing;
 4 | 
 5 | class CardService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Issuing <code>Card</code> objects. The objects are sorted in
 9 |      * descending order by creation date, with the most recently created object
10 |      * appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/issuing/cards', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Creates an Issuing <code>Card</code> object.
26 |      *
27 |      * @param null|array $params
28 |      * @param null|array|\Stripe\Util\RequestOptions $opts
29 |      *
30 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
31 |      *
32 |      * @return \Stripe\Issuing\Card
33 |      */
34 |     public function create($params = null, $opts = null)
35 |     {
36 |         return $this->request('post', '/v1/issuing/cards', $params, $opts);
37 |     }
38 | 
39 |     /**
40 |      * Retrieves an Issuing <code>Card</code> object.
41 |      *
42 |      * @param string $id
43 |      * @param null|array $params
44 |      * @param null|array|\Stripe\Util\RequestOptions $opts
45 |      *
46 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
47 |      *
48 |      * @return \Stripe\Issuing\Card
49 |      */
50 |     public function retrieve($id, $params = null, $opts = null)
51 |     {
52 |         return $this->request('get', $this->buildPath('/v1/issuing/cards/%s', $id), $params, $opts);
53 |     }
54 | 
55 |     /**
56 |      * Updates the specified Issuing <code>Card</code> object by setting the values of
57 |      * the parameters passed. Any parameters not provided will be left unchanged.
58 |      *
59 |      * @param string $id
60 |      * @param null|array $params
61 |      * @param null|array|\Stripe\Util\RequestOptions $opts
62 |      *
63 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
64 |      *
65 |      * @return \Stripe\Issuing\Card
66 |      */
67 |     public function update($id, $params = null, $opts = null)
68 |     {
69 |         return $this->request('post', $this->buildPath('/v1/issuing/cards/%s', $id), $params, $opts);
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/lib/Service/Issuing/DisputeService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Issuing;
 4 | 
 5 | class DisputeService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted
 9 |      * in descending order by creation date, with the most recently created object
10 |      * appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/issuing/disputes', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Creates an Issuing <code>Dispute</code> object.
26 |      *
27 |      * @param null|array $params
28 |      * @param null|array|\Stripe\Util\RequestOptions $opts
29 |      *
30 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
31 |      *
32 |      * @return \Stripe\Issuing\Dispute
33 |      */
34 |     public function create($params = null, $opts = null)
35 |     {
36 |         return $this->request('post', '/v1/issuing/disputes', $params, $opts);
37 |     }
38 | 
39 |     /**
40 |      * Retrieves an Issuing <code>Dispute</code> object.
41 |      *
42 |      * @param string $id
43 |      * @param null|array $params
44 |      * @param null|array|\Stripe\Util\RequestOptions $opts
45 |      *
46 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
47 |      *
48 |      * @return \Stripe\Issuing\Dispute
49 |      */
50 |     public function retrieve($id, $params = null, $opts = null)
51 |     {
52 |         return $this->request('get', $this->buildPath('/v1/issuing/disputes/%s', $id), $params, $opts);
53 |     }
54 | 
55 |     /**
56 |      * Updates the specified Issuing <code>Dispute</code> object by setting the values
57 |      * of the parameters passed. Any parameters not provided will be left unchanged.
58 |      *
59 |      * @param string $id
60 |      * @param null|array $params
61 |      * @param null|array|\Stripe\Util\RequestOptions $opts
62 |      *
63 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
64 |      *
65 |      * @return \Stripe\Issuing\Dispute
66 |      */
67 |     public function update($id, $params = null, $opts = null)
68 |     {
69 |         return $this->request('post', $this->buildPath('/v1/issuing/disputes/%s', $id), $params, $opts);
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/lib/Service/RefundService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class RefundService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of all refunds you’ve previously created. The refunds are
 9 |      * returned in sorted order, with the most recent refunds appearing first. For
10 |      * convenience, the 10 most recent refunds are always available by default on the
11 |      * charge object.
12 |      *
13 |      * @param null|array $params
14 |      * @param null|array|\Stripe\Util\RequestOptions $opts
15 |      *
16 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
17 |      *
18 |      * @return \Stripe\Collection
19 |      */
20 |     public function all($params = null, $opts = null)
21 |     {
22 |         return $this->requestCollection('get', '/v1/refunds', $params, $opts);
23 |     }
24 | 
25 |     /**
26 |      * Create a refund.
27 |      *
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\Refund
34 |      */
35 |     public function create($params = null, $opts = null)
36 |     {
37 |         return $this->request('post', '/v1/refunds', $params, $opts);
38 |     }
39 | 
40 |     /**
41 |      * Retrieves the details of an existing refund.
42 |      *
43 |      * @param string $id
44 |      * @param null|array $params
45 |      * @param null|array|\Stripe\Util\RequestOptions $opts
46 |      *
47 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
48 |      *
49 |      * @return \Stripe\Refund
50 |      */
51 |     public function retrieve($id, $params = null, $opts = null)
52 |     {
53 |         return $this->request('get', $this->buildPath('/v1/refunds/%s', $id), $params, $opts);
54 |     }
55 | 
56 |     /**
57 |      * Updates the specified refund by setting the values of the parameters passed. Any
58 |      * parameters not provided will be left unchanged.
59 |      *
60 |      * This request only accepts <code>metadata</code> as an argument.
61 |      *
62 |      * @param string $id
63 |      * @param null|array $params
64 |      * @param null|array|\Stripe\Util\RequestOptions $opts
65 |      *
66 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
67 |      *
68 |      * @return \Stripe\Refund
69 |      */
70 |     public function update($id, $params = null, $opts = null)
71 |     {
72 |         return $this->request('post', $this->buildPath('/v1/refunds/%s', $id), $params, $opts);
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/lib/Service/Radar/ValueListItemService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Radar;
 4 | 
 5 | class ValueListItemService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of <code>ValueListItem</code> objects. The objects are sorted in
 9 |      * descending order by creation date, with the most recently created object
10 |      * appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/radar/value_list_items', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Creates a new <code>ValueListItem</code> object, which is added to the specified
26 |      * parent value list.
27 |      *
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\Radar\ValueListItem
34 |      */
35 |     public function create($params = null, $opts = null)
36 |     {
37 |         return $this->request('post', '/v1/radar/value_list_items', $params, $opts);
38 |     }
39 | 
40 |     /**
41 |      * Deletes a <code>ValueListItem</code> object, removing it from its parent value
42 |      * list.
43 |      *
44 |      * @param string $id
45 |      * @param null|array $params
46 |      * @param null|array|\Stripe\Util\RequestOptions $opts
47 |      *
48 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
49 |      *
50 |      * @return \Stripe\Radar\ValueListItem
51 |      */
52 |     public function delete($id, $params = null, $opts = null)
53 |     {
54 |         return $this->request('delete', $this->buildPath('/v1/radar/value_list_items/%s', $id), $params, $opts);
55 |     }
56 | 
57 |     /**
58 |      * Retrieves a <code>ValueListItem</code> object.
59 |      *
60 |      * @param string $id
61 |      * @param null|array $params
62 |      * @param null|array|\Stripe\Util\RequestOptions $opts
63 |      *
64 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
65 |      *
66 |      * @return \Stripe\Radar\ValueListItem
67 |      */
68 |     public function retrieve($id, $params = null, $opts = null)
69 |     {
70 |         return $this->request('get', $this->buildPath('/v1/radar/value_list_items/%s', $id), $params, $opts);
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/lib/Service/Issuing/CardholderService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Issuing;
 4 | 
 5 | class CardholderService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of Issuing <code>Cardholder</code> objects. The objects are
 9 |      * sorted in descending order by creation date, with the most recently created
10 |      * object appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/issuing/cardholders', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Creates a new Issuing <code>Cardholder</code> object that can be issued cards.
26 |      *
27 |      * @param null|array $params
28 |      * @param null|array|\Stripe\Util\RequestOptions $opts
29 |      *
30 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
31 |      *
32 |      * @return \Stripe\Issuing\Cardholder
33 |      */
34 |     public function create($params = null, $opts = null)
35 |     {
36 |         return $this->request('post', '/v1/issuing/cardholders', $params, $opts);
37 |     }
38 | 
39 |     /**
40 |      * Retrieves an Issuing <code>Cardholder</code> object.
41 |      *
42 |      * @param string $id
43 |      * @param null|array $params
44 |      * @param null|array|\Stripe\Util\RequestOptions $opts
45 |      *
46 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
47 |      *
48 |      * @return \Stripe\Issuing\Cardholder
49 |      */
50 |     public function retrieve($id, $params = null, $opts = null)
51 |     {
52 |         return $this->request('get', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
53 |     }
54 | 
55 |     /**
56 |      * Updates the specified Issuing <code>Cardholder</code> object by setting the
57 |      * values of the parameters passed. Any parameters not provided will be left
58 |      * unchanged.
59 |      *
60 |      * @param string $id
61 |      * @param null|array $params
62 |      * @param null|array|\Stripe\Util\RequestOptions $opts
63 |      *
64 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
65 |      *
66 |      * @return \Stripe\Issuing\Cardholder
67 |      */
68 |     public function update($id, $params = null, $opts = null)
69 |     {
70 |         return $this->request('post', $this->buildPath('/v1/issuing/cardholders/%s', $id), $params, $opts);
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/lib/ThreeDSecure.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Cardholder authentication via 3D Secure is initiated by creating a <code>3D
 7 |  * Secure</code> object. Once the object has been created, you can use it to
 8 |  * authenticate the cardholder and create a charge.
 9 |  *
10 |  * @property string $id Unique identifier for the object.
11 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
12 |  * @property int $amount Amount of the charge that you will create when authentication completes.
13 |  * @property bool $authenticated True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
14 |  * @property \Stripe\Card $card <p>You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.</p><p>Related guide: <a href="https://stripe.com/docs/sources/cards">Card Payments with Sources</a>.</p>
15 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
16 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
17 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
18 |  * @property null|string $redirect_url If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value &quot;_callback&quot;.
19 |  * @property string $status Possible values are <code>redirect_pending</code>, <code>succeeded</code>, or <code>failed</code>. When the cardholder can be authenticated, the object starts with status <code>redirect_pending</code>. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status <code>succeeded</code>. <code>failed</code> indicates that authentication was attempted unsuccessfully.
20 |  */
21 | class ThreeDSecure extends ApiResource
22 | {
23 |     const OBJECT_NAME = 'three_d_secure';
24 | 
25 |     use ApiOperations\Create;
26 |     use ApiOperations\Retrieve;
27 | 
28 |     /**
29 |      * @return string the endpoint URL for the given class
30 |      */
31 |     public static function classUrl()
32 |     {
33 |         return '/v1/3d_secure';
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/lib/AlipayAccount.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Class AlipayAccount.
 7 |  *
 8 |  * @deprecated Alipay accounts are deprecated. Please use the sources API instead.
 9 |  * @see https://stripe.com/docs/sources/alipay
10 |  */
11 | class AlipayAccount extends ApiResource
12 | {
13 |     const OBJECT_NAME = 'alipay_account';
14 | 
15 |     use ApiOperations\Delete;
16 |     use ApiOperations\Update;
17 | 
18 |     /**
19 |      * @return string The instance URL for this resource. It needs to be special
20 |      *    cased because it doesn't fit into the standard resource pattern.
21 |      */
22 |     public function instanceUrl()
23 |     {
24 |         if ($this['customer']) {
25 |             $base = Customer::classUrl();
26 |             $parent = $this['customer'];
27 |             $path = 'sources';
28 |         } else {
29 |             $msg = 'Alipay accounts cannot be accessed without a customer ID.';
30 | 
31 |             throw new Exception\UnexpectedValueException($msg);
32 |         }
33 |         $parentExtn = \urlencode(Util\Util::utf8($parent));
34 |         $extn = \urlencode(Util\Util::utf8($this['id']));
35 | 
36 |         return "{$base}/{$parentExtn}/{$path}/{$extn}";
37 |     }
38 | 
39 |     /**
40 |      * @param array|string $_id
41 |      * @param null|array|string $_opts
42 |      *
43 |      * @throws \Stripe\Exception\BadMethodCallException
44 |      *
45 |      * @deprecated Alipay accounts are deprecated. Please use the sources API instead.
46 |      * @see https://stripe.com/docs/sources/alipay
47 |      */
48 |     public static function retrieve($_id, $_opts = null)
49 |     {
50 |         $msg = 'Alipay accounts cannot be retrieved without a customer ID. ' .
51 |                'Retrieve an Alipay account using `Customer::retrieveSource(' .
52 |                "'customer_id', 'alipay_account_id')`.";
53 | 
54 |         throw new Exception\BadMethodCallException($msg);
55 |     }
56 | 
57 |     /**
58 |      * @param string $_id
59 |      * @param null|array $_params
60 |      * @param null|array|string $_options
61 |      *
62 |      * @throws \Stripe\Exception\BadMethodCallException
63 |      *
64 |      * @deprecated Alipay accounts are deprecated. Please use the sources API instead.
65 |      * @see https://stripe.com/docs/sources/alipay
66 |      */
67 |     public static function update($_id, $_params = null, $_options = null)
68 |     {
69 |         $msg = 'Alipay accounts cannot be updated without a customer ID. ' .
70 |                'Update an Alipay account using `Customer::updateSource(' .
71 |                "'customer_id', 'alipay_account_id', \$updateParams)`.";
72 | 
73 |         throw new Exception\BadMethodCallException($msg);
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/lib/ApplicationFeeRefund.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * <code>Application Fee Refund</code> objects allow you to refund an application
 7 |  * fee that has previously been created but not yet refunded. Funds will be
 8 |  * refunded to the Stripe account from which the fee was originally collected.
 9 |  *
10 |  * Related guide: <a
11 |  * href="https://stripe.com/docs/connect/destination-charges#refunding-app-fee">Refunding
12 |  * Application Fees</a>.
13 |  *
14 |  * @property string $id Unique identifier for the object.
15 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
16 |  * @property int $amount Amount, in %s.
17 |  * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance.
18 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
19 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
20 |  * @property string|\Stripe\ApplicationFee $fee ID of the application fee that was refunded.
21 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
22 |  */
23 | class ApplicationFeeRefund extends ApiResource
24 | {
25 |     const OBJECT_NAME = 'fee_refund';
26 | 
27 |     use ApiOperations\Update {
28 |         save as protected _save;
29 |     }
30 | 
31 |     /**
32 |      * @return string the API URL for this Stripe refund
33 |      */
34 |     public function instanceUrl()
35 |     {
36 |         $id = $this['id'];
37 |         $fee = $this['fee'];
38 |         if (!$id) {
39 |             throw new Exception\UnexpectedValueException(
40 |                 'Could not determine which URL to request: ' .
41 |                 "class instance has invalid ID: {$id}",
42 |                 null
43 |             );
44 |         }
45 |         $id = Util\Util::utf8($id);
46 |         $fee = Util\Util::utf8($fee);
47 | 
48 |         $base = ApplicationFee::classUrl();
49 |         $feeExtn = \urlencode($fee);
50 |         $extn = \urlencode($id);
51 | 
52 |         return "{$base}/{$feeExtn}/refunds/{$extn}";
53 |     }
54 | 
55 |     /**
56 |      * @param null|array|string $opts
57 |      *
58 |      * @return ApplicationFeeRefund the saved refund
59 |      */
60 |     public function save($opts = null)
61 |     {
62 |         return $this->_save($opts);
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------
/lib/ApiOperations/Request.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\ApiOperations;
 4 | 
 5 | /**
 6 |  * Trait for resources that need to make API requests.
 7 |  *
 8 |  * This trait should only be applied to classes that derive from StripeObject.
 9 |  */
10 | trait Request
11 | {
12 |     /**
13 |      * @param null|array|mixed $params The list of parameters to validate
14 |      *
15 |      * @throws \Stripe\Exception\InvalidArgumentException if $params exists and is not an array
16 |      */
17 |     protected static function _validateParams($params = null)
18 |     {
19 |         if ($params && !\is_array($params)) {
20 |             $message = 'You must pass an array as the first argument to Stripe API '
21 |                . 'method calls.  (HINT: an example call to create a charge '
22 |                . "would be: \"Stripe\\Charge::create(['amount' => 100, "
23 |                . "'currency' => 'usd', 'source' => 'tok_1234'])\")";
24 | 
25 |             throw new \Stripe\Exception\InvalidArgumentException($message);
26 |         }
27 |     }
28 | 
29 |     /**
30 |      * @param string $method HTTP method ('get', 'post', etc.)
31 |      * @param string $url URL for the request
32 |      * @param array $params list of parameters for the request
33 |      * @param null|array|string $options
34 |      *
35 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
36 |      *
37 |      * @return array tuple containing (the JSON response, $options)
38 |      */
39 |     protected function _request($method, $url, $params = [], $options = null)
40 |     {
41 |         $opts = $this->_opts->merge($options);
42 |         list($resp, $options) = static::_staticRequest($method, $url, $params, $opts);
43 |         $this->setLastResponse($resp);
44 | 
45 |         return [$resp->json, $options];
46 |     }
47 | 
48 |     /**
49 |      * @param string $method HTTP method ('get', 'post', etc.)
50 |      * @param string $url URL for the request
51 |      * @param array $params list of parameters for the request
52 |      * @param null|array|string $options
53 |      *
54 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
55 |      *
56 |      * @return array tuple containing (the JSON response, $options)
57 |      */
58 |     protected static function _staticRequest($method, $url, $params, $options)
59 |     {
60 |         $opts = \Stripe\Util\RequestOptions::parse($options);
61 |         $baseUrl = isset($opts->apiBase) ? $opts->apiBase : static::baseUrl();
62 |         $requestor = new \Stripe\ApiRequestor($opts->apiKey, $baseUrl);
63 |         list($response, $opts->apiKey) = $requestor->request($method, $url, $params, $opts->headers);
64 |         $opts->discardNonPersistentHeaders();
65 | 
66 |         return [$response, $opts];
67 |     }
68 | }
69 | 


--------------------------------------------------------------------------------
/lib/InvoiceLineItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * @property string $id Unique identifier for the object.
 7 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
 8 |  * @property int $amount The amount, in %s.
 9 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
10 |  * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
11 |  * @property bool $discountable If true, discounts will apply to this line item. Always false for prorations.
12 |  * @property string $invoice_item The ID of the <a href="https://stripe.com/docs/api/invoiceitems">invoice item</a> associated with this line item if any.
13 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
14 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with <code>type=subscription</code> this will reflect the metadata of the subscription that caused the line item to be created.
15 |  * @property \Stripe\StripeObject $period
16 |  * @property null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration.
17 |  * @property null|\Stripe\Price $price The price of the line item.
18 |  * @property bool $proration Whether this is a proration.
19 |  * @property null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration.
20 |  * @property null|string $subscription The subscription that the invoice item pertains to, if any.
21 |  * @property string $subscription_item The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.
22 |  * @property null|\Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item
23 |  * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item.
24 |  * @property string $type A string identifying the type of the source of this line item, either an <code>invoiceitem</code> or a <code>subscription</code>.
25 |  * @property bool $unified_proration For prorations this indicates whether Stripe automatically grouped multiple related debit and credit line items into a single combined line item.
26 |  */
27 | class InvoiceLineItem extends ApiResource
28 | {
29 |     const OBJECT_NAME = 'line_item';
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Service/Terminal/ReaderService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Terminal;
 4 | 
 5 | class ReaderService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of <code>Reader</code> objects.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/terminal/readers', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Creates a new <code>Reader</code> object.
24 |      *
25 |      * @param null|array $params
26 |      * @param null|array|\Stripe\Util\RequestOptions $opts
27 |      *
28 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
29 |      *
30 |      * @return \Stripe\Terminal\Reader
31 |      */
32 |     public function create($params = null, $opts = null)
33 |     {
34 |         return $this->request('post', '/v1/terminal/readers', $params, $opts);
35 |     }
36 | 
37 |     /**
38 |      * Deletes a <code>Reader</code> object.
39 |      *
40 |      * @param string $id
41 |      * @param null|array $params
42 |      * @param null|array|\Stripe\Util\RequestOptions $opts
43 |      *
44 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
45 |      *
46 |      * @return \Stripe\Terminal\Reader
47 |      */
48 |     public function delete($id, $params = null, $opts = null)
49 |     {
50 |         return $this->request('delete', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
51 |     }
52 | 
53 |     /**
54 |      * Retrieves a <code>Reader</code> object.
55 |      *
56 |      * @param string $id
57 |      * @param null|array $params
58 |      * @param null|array|\Stripe\Util\RequestOptions $opts
59 |      *
60 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
61 |      *
62 |      * @return \Stripe\Terminal\Reader
63 |      */
64 |     public function retrieve($id, $params = null, $opts = null)
65 |     {
66 |         return $this->request('get', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
67 |     }
68 | 
69 |     /**
70 |      * Updates a <code>Reader</code> object by setting the values of the parameters
71 |      * passed. Any parameters not provided will be left unchanged.
72 |      *
73 |      * @param string $id
74 |      * @param null|array $params
75 |      * @param null|array|\Stripe\Util\RequestOptions $opts
76 |      *
77 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
78 |      *
79 |      * @return \Stripe\Terminal\Reader
80 |      */
81 |     public function update($id, $params = null, $opts = null)
82 |     {
83 |         return $this->request('post', $this->buildPath('/v1/terminal/readers/%s', $id), $params, $opts);
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/lib/Service/TopupService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class TopupService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of top-ups.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/topups', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Cancels a top-up. Only pending top-ups can be canceled.
24 |      *
25 |      * @param string $id
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\Topup
32 |      */
33 |     public function cancel($id, $params = null, $opts = null)
34 |     {
35 |         return $this->request('post', $this->buildPath('/v1/topups/%s/cancel', $id), $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Top up the balance of an account.
40 |      *
41 |      * @param null|array $params
42 |      * @param null|array|\Stripe\Util\RequestOptions $opts
43 |      *
44 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
45 |      *
46 |      * @return \Stripe\Topup
47 |      */
48 |     public function create($params = null, $opts = null)
49 |     {
50 |         return $this->request('post', '/v1/topups', $params, $opts);
51 |     }
52 | 
53 |     /**
54 |      * Retrieves the details of a top-up that has previously been created. Supply the
55 |      * unique top-up ID that was returned from your previous request, and Stripe will
56 |      * return the corresponding top-up information.
57 |      *
58 |      * @param string $id
59 |      * @param null|array $params
60 |      * @param null|array|\Stripe\Util\RequestOptions $opts
61 |      *
62 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
63 |      *
64 |      * @return \Stripe\Topup
65 |      */
66 |     public function retrieve($id, $params = null, $opts = null)
67 |     {
68 |         return $this->request('get', $this->buildPath('/v1/topups/%s', $id), $params, $opts);
69 |     }
70 | 
71 |     /**
72 |      * Updates the metadata of a top-up. Other top-up details are not editable by
73 |      * design.
74 |      *
75 |      * @param string $id
76 |      * @param null|array $params
77 |      * @param null|array|\Stripe\Util\RequestOptions $opts
78 |      *
79 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
80 |      *
81 |      * @return \Stripe\Topup
82 |      */
83 |     public function update($id, $params = null, $opts = null)
84 |     {
85 |         return $this->request('post', $this->buildPath('/v1/topups/%s', $id), $params, $opts);
86 |     }
87 | }
88 | 


--------------------------------------------------------------------------------
/lib/SKU.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Stores representations of <a
 7 |  * href="http://en.wikipedia.org/wiki/Stock_keeping_unit">stock keeping units</a>.
 8 |  * SKUs describe specific product variations, taking into account any combination
 9 |  * of: attributes, currency, and cost. For example, a product may be a T-shirt,
10 |  * whereas a specific SKU represents the <code>size: large</code>, <code>color:
11 |  * red</code> version of that shirt.
12 |  *
13 |  * Can also be used to manage inventory.
14 |  *
15 |  * Related guide: <a href="https://stripe.com/docs/orders">Tax, Shipping, and
16 |  * Inventory</a>.
17 |  *
18 |  * @property string $id Unique identifier for the object.
19 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
20 |  * @property bool $active Whether the SKU is available for purchase.
21 |  * @property \Stripe\StripeObject $attributes A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are <code>[&quot;size&quot;, &quot;gender&quot;]</code>, a valid SKU has the following dictionary of attributes: <code>{&quot;size&quot;: &quot;Medium&quot;, &quot;gender&quot;: &quot;Unisex&quot;}</code>.
22 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
23 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
24 |  * @property null|string $image The URL of an image for this SKU, meant to be displayable to the customer.
25 |  * @property \Stripe\StripeObject $inventory
26 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
27 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
28 |  * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this SKU for shipping purposes.
29 |  * @property int $price The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).
30 |  * @property string|\Stripe\Product $product The ID of the product this SKU is associated with. The product must be currently active.
31 |  * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
32 |  */
33 | class SKU extends ApiResource
34 | {
35 |     const OBJECT_NAME = 'sku';
36 | 
37 |     use ApiOperations\All;
38 |     use ApiOperations\Create;
39 |     use ApiOperations\Delete;
40 |     use ApiOperations\Retrieve;
41 |     use ApiOperations\Update;
42 | }
43 | 


--------------------------------------------------------------------------------
/lib/Service/Terminal/LocationService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Terminal;
 4 | 
 5 | class LocationService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of <code>Location</code> objects.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/terminal/locations', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Creates a new <code>Location</code> object.
24 |      *
25 |      * @param null|array $params
26 |      * @param null|array|\Stripe\Util\RequestOptions $opts
27 |      *
28 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
29 |      *
30 |      * @return \Stripe\Terminal\Location
31 |      */
32 |     public function create($params = null, $opts = null)
33 |     {
34 |         return $this->request('post', '/v1/terminal/locations', $params, $opts);
35 |     }
36 | 
37 |     /**
38 |      * Deletes a <code>Location</code> object.
39 |      *
40 |      * @param string $id
41 |      * @param null|array $params
42 |      * @param null|array|\Stripe\Util\RequestOptions $opts
43 |      *
44 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
45 |      *
46 |      * @return \Stripe\Terminal\Location
47 |      */
48 |     public function delete($id, $params = null, $opts = null)
49 |     {
50 |         return $this->request('delete', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
51 |     }
52 | 
53 |     /**
54 |      * Retrieves a <code>Location</code> object.
55 |      *
56 |      * @param string $id
57 |      * @param null|array $params
58 |      * @param null|array|\Stripe\Util\RequestOptions $opts
59 |      *
60 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
61 |      *
62 |      * @return \Stripe\Terminal\Location
63 |      */
64 |     public function retrieve($id, $params = null, $opts = null)
65 |     {
66 |         return $this->request('get', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
67 |     }
68 | 
69 |     /**
70 |      * Updates a <code>Location</code> object by setting the values of the parameters
71 |      * passed. Any parameters not provided will be left unchanged.
72 |      *
73 |      * @param string $id
74 |      * @param null|array $params
75 |      * @param null|array|\Stripe\Util\RequestOptions $opts
76 |      *
77 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
78 |      *
79 |      * @return \Stripe\Terminal\Location
80 |      */
81 |     public function update($id, $params = null, $opts = null)
82 |     {
83 |         return $this->request('post', $this->buildPath('/v1/terminal/locations/%s', $id), $params, $opts);
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/lib/Coupon.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * A coupon contains information about a percent-off or amount-off discount you
 7 |  * might want to apply to a customer. Coupons may be applied to <a
 8 |  * href="https://stripe.com/docs/api#invoices">invoices</a> or <a
 9 |  * href="https://stripe.com/docs/api#create_order-coupon">orders</a>. Coupons do
10 |  * not work with conventional one-off <a
11 |  * href="https://stripe.com/docs/api#create_charge">charges</a>.
12 |  *
13 |  * @property string $id Unique identifier for the object.
14 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
15 |  * @property null|int $amount_off Amount (in the <code>currency</code> specified) that will be taken off the subtotal of any invoices for this customer.
16 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
17 |  * @property null|string $currency If <code>amount_off</code> has been set, the three-letter <a href="https://stripe.com/docs/currencies">ISO code for the currency</a> of the amount to take off.
18 |  * @property string $duration One of <code>forever</code>, <code>once</code>, and <code>repeating</code>. Describes how long a customer who applies this coupon will get the discount.
19 |  * @property null|int $duration_in_months If <code>duration</code> is <code>repeating</code>, the number of months the coupon applies. Null if coupon <code>duration</code> is <code>forever</code> or <code>once</code>.
20 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
21 |  * @property null|int $max_redemptions Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
22 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
23 |  * @property null|string $name Name of the coupon displayed to customers on for instance invoices or receipts.
24 |  * @property null|float $percent_off Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.
25 |  * @property null|int $redeem_by Date after which the coupon can no longer be redeemed.
26 |  * @property int $times_redeemed Number of times this coupon has been applied to a customer.
27 |  * @property bool $valid Taking account of the above properties, whether this coupon can still be applied to a customer.
28 |  */
29 | class Coupon extends ApiResource
30 | {
31 |     const OBJECT_NAME = 'coupon';
32 | 
33 |     use ApiOperations\All;
34 |     use ApiOperations\Create;
35 |     use ApiOperations\Delete;
36 |     use ApiOperations\Retrieve;
37 |     use ApiOperations\Update;
38 | }
39 | 


--------------------------------------------------------------------------------
/lib/Service/PlanService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class PlanService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your plans.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/plans', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * You can create plans using the API, or in the Stripe <a
24 |      * href="https://dashboard.stripe.com/products">Dashboard</a>.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\Plan
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         return $this->request('post', '/v1/plans', $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Deleting plans means new subscribers can’t be added. Existing subscribers aren’t
40 |      * affected.
41 |      *
42 |      * @param string $id
43 |      * @param null|array $params
44 |      * @param null|array|\Stripe\Util\RequestOptions $opts
45 |      *
46 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
47 |      *
48 |      * @return \Stripe\Plan
49 |      */
50 |     public function delete($id, $params = null, $opts = null)
51 |     {
52 |         return $this->request('delete', $this->buildPath('/v1/plans/%s', $id), $params, $opts);
53 |     }
54 | 
55 |     /**
56 |      * Retrieves the plan with the given ID.
57 |      *
58 |      * @param string $id
59 |      * @param null|array $params
60 |      * @param null|array|\Stripe\Util\RequestOptions $opts
61 |      *
62 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
63 |      *
64 |      * @return \Stripe\Plan
65 |      */
66 |     public function retrieve($id, $params = null, $opts = null)
67 |     {
68 |         return $this->request('get', $this->buildPath('/v1/plans/%s', $id), $params, $opts);
69 |     }
70 | 
71 |     /**
72 |      * Updates the specified plan by setting the values of the parameters passed. Any
73 |      * parameters not provided are left unchanged. By design, you cannot change a
74 |      * plan’s ID, amount, currency, or billing cycle.
75 |      *
76 |      * @param string $id
77 |      * @param null|array $params
78 |      * @param null|array|\Stripe\Util\RequestOptions $opts
79 |      *
80 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
81 |      *
82 |      * @return \Stripe\Plan
83 |      */
84 |     public function update($id, $params = null, $opts = null)
85 |     {
86 |         return $this->request('post', $this->buildPath('/v1/plans/%s', $id), $params, $opts);
87 |     }
88 | }
89 | 


--------------------------------------------------------------------------------
/lib/Recipient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * With <code>Recipient</code> objects, you can transfer money from your Stripe
 7 |  * account to a third-party bank account or debit card. The API allows you to
 8 |  * create, delete, and update your recipients. You can retrieve individual
 9 |  * recipients as well as a list of all your recipients.
10 |  *
11 |  * <strong><code>Recipient</code> objects have been deprecated in favor of <a
12 |  * href="https://stripe.com/docs/connect">Connect</a>, specifically Connect's much
13 |  * more powerful <a href="https://stripe.com/docs/api#account">Account objects</a>.
14 |  * Stripe accounts that don't already use recipients can no longer begin doing so.
15 |  * Please use <code>Account</code> objects instead. If you are already using
16 |  * recipients, please see our <a
17 |  * href="https://stripe.com/docs/connect/recipient-account-migrations">migration
18 |  * guide</a> for more information.</strong>
19 |  *
20 |  * @property string $id Unique identifier for the object.
21 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
22 |  * @property null|\Stripe\BankAccount $active_account Hash describing the current account on the recipient, if there is one.
23 |  * @property null|\Stripe\Collection $cards
24 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
25 |  * @property null|string|\Stripe\Card $default_card The default card to use for creating transfers to this recipient.
26 |  * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users.
27 |  * @property null|string $email
28 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
29 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
30 |  * @property null|string|\Stripe\Account $migrated_to The ID of the <a href="https://stripe.com/docs/connect/custom-accounts">Custom account</a> this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.
31 |  * @property null|string $name Full, legal name of the recipient.
32 |  * @property string|\Stripe\Account $rolled_back_from
33 |  * @property string $type Type of the recipient, one of <code>individual</code> or <code>corporation</code>.
34 |  * @property bool $verified Whether the recipient has been verified. This field is non-standard, and maybe removed in the future
35 |  */
36 | class Recipient extends ApiResource
37 | {
38 |     const OBJECT_NAME = 'recipient';
39 | 
40 |     use ApiOperations\All;
41 |     use ApiOperations\Create;
42 |     use ApiOperations\Delete;
43 |     use ApiOperations\Retrieve;
44 |     use ApiOperations\Update;
45 | }
46 | 


--------------------------------------------------------------------------------
/lib/Issuing/Transaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Issuing;
 4 | 
 5 | /**
 6 |  * Any use of an <a href="https://stripe.com/docs/issuing">issued card</a> that
 7 |  * results in funds entering or leaving your Stripe account, such as a completed
 8 |  * purchase or refund, is represented by an Issuing <code>Transaction</code>
 9 |  * object.
10 |  *
11 |  * Related guide: <a
12 |  * href="https://stripe.com/docs/issuing/purchases/transactions">Issued Card
13 |  * Transactions</a>.
14 |  *
15 |  * @property string $id Unique identifier for the object.
16 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
17 |  * @property int $amount The transaction amount, which will be reflected in your balance. This amount is in your currency and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>.
18 |  * @property null|string|\Stripe\Issuing\Authorization $authorization The <code>Authorization</code> object that led to this transaction.
19 |  * @property null|string|\Stripe\BalanceTransaction $balance_transaction ID of the <a href="https://stripe.com/docs/api/balance_transactions">balance transaction</a> associated with this transaction.
20 |  * @property string|\Stripe\Issuing\Card $card The card used to make this transaction.
21 |  * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this transaction belongs.
22 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
23 |  * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase. Must be a <a href="https://stripe.com/docs/currencies">supported currency</a>.
24 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
25 |  * @property int $merchant_amount The amount that the merchant will receive, denominated in <code>merchant_currency</code> and in the <a href="https://stripe.com/docs/currencies#zero-decimal">smallest currency unit</a>. It will be different from <code>amount</code> if the merchant is taking payment in a different currency.
26 |  * @property string $merchant_currency The currency with which the merchant is taking payment.
27 |  * @property \Stripe\StripeObject $merchant_data
28 |  * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
29 |  * @property null|\Stripe\StripeObject $purchase_details Additional purchase information that is optionally provided by the merchant.
30 |  * @property string $type The nature of the transaction.
31 |  */
32 | class Transaction extends \Stripe\ApiResource
33 | {
34 |     const OBJECT_NAME = 'issuing.transaction';
35 | 
36 |     use \Stripe\ApiOperations\All;
37 |     use \Stripe\ApiOperations\Retrieve;
38 |     use \Stripe\ApiOperations\Update;
39 | }
40 | 


--------------------------------------------------------------------------------
/lib/Service/DisputeService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class DisputeService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your disputes.
 9 |      *
10 |      * @param null|array $params
11 |      * @param null|array|\Stripe\Util\RequestOptions $opts
12 |      *
13 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
14 |      *
15 |      * @return \Stripe\Collection
16 |      */
17 |     public function all($params = null, $opts = null)
18 |     {
19 |         return $this->requestCollection('get', '/v1/disputes', $params, $opts);
20 |     }
21 | 
22 |     /**
23 |      * Closing the dispute for a charge indicates that you do not have any evidence to
24 |      * submit and are essentially dismissing the dispute, acknowledging it as lost.
25 |      *
26 |      * The status of the dispute will change from <code>needs_response</code> to
27 |      * <code>lost</code>. <em>Closing a dispute is irreversible</em>.
28 |      *
29 |      * @param string $id
30 |      * @param null|array $params
31 |      * @param null|array|\Stripe\Util\RequestOptions $opts
32 |      *
33 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
34 |      *
35 |      * @return \Stripe\Dispute
36 |      */
37 |     public function close($id, $params = null, $opts = null)
38 |     {
39 |         return $this->request('post', $this->buildPath('/v1/disputes/%s/close', $id), $params, $opts);
40 |     }
41 | 
42 |     /**
43 |      * Retrieves the dispute with the given ID.
44 |      *
45 |      * @param string $id
46 |      * @param null|array $params
47 |      * @param null|array|\Stripe\Util\RequestOptions $opts
48 |      *
49 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
50 |      *
51 |      * @return \Stripe\Dispute
52 |      */
53 |     public function retrieve($id, $params = null, $opts = null)
54 |     {
55 |         return $this->request('get', $this->buildPath('/v1/disputes/%s', $id), $params, $opts);
56 |     }
57 | 
58 |     /**
59 |      * When you get a dispute, contacting your customer is always the best first step.
60 |      * If that doesn’t work, you can submit evidence to help us resolve the dispute in
61 |      * your favor. You can do this in your <a
62 |      * href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer,
63 |      * you can use the API to submit evidence programmatically.
64 |      *
65 |      * Depending on your dispute type, different evidence fields will give you a better
66 |      * chance of winning your dispute. To figure out which evidence fields to provide,
67 |      * see our <a href="/docs/disputes/categories">guide to dispute types</a>.
68 |      *
69 |      * @param string $id
70 |      * @param null|array $params
71 |      * @param null|array|\Stripe\Util\RequestOptions $opts
72 |      *
73 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
74 |      *
75 |      * @return \Stripe\Dispute
76 |      */
77 |     public function update($id, $params = null, $opts = null)
78 |     {
79 |         return $this->request('post', $this->buildPath('/v1/disputes/%s', $id), $params, $opts);
80 |     }
81 | }
82 | 


--------------------------------------------------------------------------------
/lib/Capability.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * This is an object representing a capability for a Stripe account.
 7 |  *
 8 |  * Related guide: <a
 9 |  * href="https://stripe.com/docs/connect/account-capabilities">Account
10 |  * capabilities</a>.
11 |  *
12 |  * @property string $id The identifier for the capability.
13 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
14 |  * @property string|\Stripe\Account $account The account for which the capability enables functionality.
15 |  * @property bool $requested Whether the capability has been requested.
16 |  * @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch.
17 |  * @property \Stripe\StripeObject $requirements
18 |  * @property string $status The status of the capability. Can be <code>active</code>, <code>inactive</code>, <code>pending</code>, or <code>unrequested</code>.
19 |  */
20 | class Capability extends ApiResource
21 | {
22 |     const OBJECT_NAME = 'capability';
23 | 
24 |     use ApiOperations\Update;
25 | 
26 |     const STATUS_ACTIVE = 'active';
27 |     const STATUS_INACTIVE = 'inactive';
28 |     const STATUS_PENDING = 'pending';
29 |     const STATUS_UNREQUESTED = 'unrequested';
30 | 
31 |     /**
32 |      * @return string the API URL for this Stripe account reversal
33 |      */
34 |     public function instanceUrl()
35 |     {
36 |         $id = $this['id'];
37 |         $account = $this['account'];
38 |         if (!$id) {
39 |             throw new Exception\UnexpectedValueException(
40 |                 'Could not determine which URL to request: ' .
41 |                 "class instance has invalid ID: {$id}",
42 |                 null
43 |             );
44 |         }
45 |         $id = Util\Util::utf8($id);
46 |         $account = Util\Util::utf8($account);
47 | 
48 |         $base = Account::classUrl();
49 |         $accountExtn = \urlencode($account);
50 |         $extn = \urlencode($id);
51 | 
52 |         return "{$base}/{$accountExtn}/capabilities/{$extn}";
53 |     }
54 | 
55 |     /**
56 |      * @param array|string $_id
57 |      * @param null|array|string $_opts
58 |      *
59 |      * @throws \Stripe\Exception\BadMethodCallException
60 |      */
61 |     public static function retrieve($_id, $_opts = null)
62 |     {
63 |         $msg = 'Capabilities cannot be retrieved without an account ID. ' .
64 |                'Retrieve a capability using `Account::retrieveCapability(' .
65 |                "'account_id', 'capability_id')`.";
66 | 
67 |         throw new Exception\BadMethodCallException($msg);
68 |     }
69 | 
70 |     /**
71 |      * @param string $_id
72 |      * @param null|array $_params
73 |      * @param null|array|string $_options
74 |      *
75 |      * @throws \Stripe\Exception\BadMethodCallException
76 |      */
77 |     public static function update($_id, $_params = null, $_options = null)
78 |     {
79 |         $msg = 'Capabilities cannot be updated without an account ID. ' .
80 |                'Update a capability using `Account::updateCapability(' .
81 |                "'account_id', 'capability_id', \$updateParams)`.";
82 | 
83 |         throw new Exception\BadMethodCallException($msg);
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/lib/Service/ProductService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class ProductService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your products. The products are returned sorted by creation
 9 |      * date, with the most recently created products appearing first.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/products', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates a new product object.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\Product
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         return $this->request('post', '/v1/products', $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Delete a product. Deleting a product is only possible if it has no prices
40 |      * associated with it. Additionally, deleting a product with <code>type=good</code>
41 |      * is only possible if it has no SKUs associated with it.
42 |      *
43 |      * @param string $id
44 |      * @param null|array $params
45 |      * @param null|array|\Stripe\Util\RequestOptions $opts
46 |      *
47 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
48 |      *
49 |      * @return \Stripe\Product
50 |      */
51 |     public function delete($id, $params = null, $opts = null)
52 |     {
53 |         return $this->request('delete', $this->buildPath('/v1/products/%s', $id), $params, $opts);
54 |     }
55 | 
56 |     /**
57 |      * Retrieves the details of an existing product. Supply the unique product ID from
58 |      * either a product creation request or the product list, and Stripe will return
59 |      * the corresponding product information.
60 |      *
61 |      * @param string $id
62 |      * @param null|array $params
63 |      * @param null|array|\Stripe\Util\RequestOptions $opts
64 |      *
65 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
66 |      *
67 |      * @return \Stripe\Product
68 |      */
69 |     public function retrieve($id, $params = null, $opts = null)
70 |     {
71 |         return $this->request('get', $this->buildPath('/v1/products/%s', $id), $params, $opts);
72 |     }
73 | 
74 |     /**
75 |      * Updates the specific product by setting the values of the parameters passed. Any
76 |      * parameters not provided will be left unchanged.
77 |      *
78 |      * @param string $id
79 |      * @param null|array $params
80 |      * @param null|array|\Stripe\Util\RequestOptions $opts
81 |      *
82 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
83 |      *
84 |      * @return \Stripe\Product
85 |      */
86 |     public function update($id, $params = null, $opts = null)
87 |     {
88 |         return $this->request('post', $this->buildPath('/v1/products/%s', $id), $params, $opts);
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/lib/Service/InvoiceItemService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class InvoiceItemService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your invoice items. Invoice items are returned sorted by
 9 |      * creation date, with the most recently created invoice items appearing first.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/invoiceitems', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates an item to be added to a draft invoice. If no invoice is specified, the
25 |      * item will be on the next invoice created for the customer specified.
26 |      *
27 |      * @param null|array $params
28 |      * @param null|array|\Stripe\Util\RequestOptions $opts
29 |      *
30 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
31 |      *
32 |      * @return \Stripe\InvoiceItem
33 |      */
34 |     public function create($params = null, $opts = null)
35 |     {
36 |         return $this->request('post', '/v1/invoiceitems', $params, $opts);
37 |     }
38 | 
39 |     /**
40 |      * Deletes an invoice item, removing it from an invoice. Deleting invoice items is
41 |      * only possible when they’re not attached to invoices, or if it’s attached to a
42 |      * draft invoice.
43 |      *
44 |      * @param string $id
45 |      * @param null|array $params
46 |      * @param null|array|\Stripe\Util\RequestOptions $opts
47 |      *
48 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
49 |      *
50 |      * @return \Stripe\InvoiceItem
51 |      */
52 |     public function delete($id, $params = null, $opts = null)
53 |     {
54 |         return $this->request('delete', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts);
55 |     }
56 | 
57 |     /**
58 |      * Retrieves the invoice item with the given ID.
59 |      *
60 |      * @param string $id
61 |      * @param null|array $params
62 |      * @param null|array|\Stripe\Util\RequestOptions $opts
63 |      *
64 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
65 |      *
66 |      * @return \Stripe\InvoiceItem
67 |      */
68 |     public function retrieve($id, $params = null, $opts = null)
69 |     {
70 |         return $this->request('get', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts);
71 |     }
72 | 
73 |     /**
74 |      * Updates the amount or description of an invoice item on an upcoming invoice.
75 |      * Updating an invoice item is only possible before the invoice it’s attached to is
76 |      * closed.
77 |      *
78 |      * @param string $id
79 |      * @param null|array $params
80 |      * @param null|array|\Stripe\Util\RequestOptions $opts
81 |      *
82 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
83 |      *
84 |      * @return \Stripe\InvoiceItem
85 |      */
86 |     public function update($id, $params = null, $opts = null)
87 |     {
88 |         return $this->request('post', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts);
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/lib/Service/SkuService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service;
 4 | 
 5 | class SkuService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of your SKUs. The SKUs are returned sorted by creation date, with
 9 |      * the most recently created SKUs appearing first.
10 |      *
11 |      * @param null|array $params
12 |      * @param null|array|\Stripe\Util\RequestOptions $opts
13 |      *
14 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
15 |      *
16 |      * @return \Stripe\Collection
17 |      */
18 |     public function all($params = null, $opts = null)
19 |     {
20 |         return $this->requestCollection('get', '/v1/skus', $params, $opts);
21 |     }
22 | 
23 |     /**
24 |      * Creates a new SKU associated with a product.
25 |      *
26 |      * @param null|array $params
27 |      * @param null|array|\Stripe\Util\RequestOptions $opts
28 |      *
29 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
30 |      *
31 |      * @return \Stripe\SKU
32 |      */
33 |     public function create($params = null, $opts = null)
34 |     {
35 |         return $this->request('post', '/v1/skus', $params, $opts);
36 |     }
37 | 
38 |     /**
39 |      * Delete a SKU. Deleting a SKU is only possible until it has been used in an
40 |      * order.
41 |      *
42 |      * @param string $id
43 |      * @param null|array $params
44 |      * @param null|array|\Stripe\Util\RequestOptions $opts
45 |      *
46 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
47 |      *
48 |      * @return \Stripe\SKU
49 |      */
50 |     public function delete($id, $params = null, $opts = null)
51 |     {
52 |         return $this->request('delete', $this->buildPath('/v1/skus/%s', $id), $params, $opts);
53 |     }
54 | 
55 |     /**
56 |      * Retrieves the details of an existing SKU. Supply the unique SKU identifier from
57 |      * either a SKU creation request or from the product, and Stripe will return the
58 |      * corresponding SKU information.
59 |      *
60 |      * @param string $id
61 |      * @param null|array $params
62 |      * @param null|array|\Stripe\Util\RequestOptions $opts
63 |      *
64 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
65 |      *
66 |      * @return \Stripe\SKU
67 |      */
68 |     public function retrieve($id, $params = null, $opts = null)
69 |     {
70 |         return $this->request('get', $this->buildPath('/v1/skus/%s', $id), $params, $opts);
71 |     }
72 | 
73 |     /**
74 |      * Updates the specific SKU by setting the values of the parameters passed. Any
75 |      * parameters not provided will be left unchanged.
76 |      *
77 |      * Note that a SKU’s <code>attributes</code> are not editable. Instead, you would
78 |      * need to deactivate the existing SKU and create a new one with the new attribute
79 |      * values.
80 |      *
81 |      * @param string $id
82 |      * @param null|array $params
83 |      * @param null|array|\Stripe\Util\RequestOptions $opts
84 |      *
85 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
86 |      *
87 |      * @return \Stripe\SKU
88 |      */
89 |     public function update($id, $params = null, $opts = null)
90 |     {
91 |         return $this->request('post', $this->buildPath('/v1/skus/%s', $id), $params, $opts);
92 |     }
93 | }
94 | 


--------------------------------------------------------------------------------
/lib/Service/Radar/ValueListService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe\Service\Radar;
 4 | 
 5 | class ValueListService extends \Stripe\Service\AbstractService
 6 | {
 7 |     /**
 8 |      * Returns a list of <code>ValueList</code> objects. The objects are sorted in
 9 |      * descending order by creation date, with the most recently created object
10 |      * appearing first.
11 |      *
12 |      * @param null|array $params
13 |      * @param null|array|\Stripe\Util\RequestOptions $opts
14 |      *
15 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
16 |      *
17 |      * @return \Stripe\Collection
18 |      */
19 |     public function all($params = null, $opts = null)
20 |     {
21 |         return $this->requestCollection('get', '/v1/radar/value_lists', $params, $opts);
22 |     }
23 | 
24 |     /**
25 |      * Creates a new <code>ValueList</code> object, which can then be referenced in
26 |      * rules.
27 |      *
28 |      * @param null|array $params
29 |      * @param null|array|\Stripe\Util\RequestOptions $opts
30 |      *
31 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
32 |      *
33 |      * @return \Stripe\Radar\ValueList
34 |      */
35 |     public function create($params = null, $opts = null)
36 |     {
37 |         return $this->request('post', '/v1/radar/value_lists', $params, $opts);
38 |     }
39 | 
40 |     /**
41 |      * Deletes a <code>ValueList</code> object, also deleting any items contained
42 |      * within the value list. To be deleted, a value list must not be referenced in any
43 |      * rules.
44 |      *
45 |      * @param string $id
46 |      * @param null|array $params
47 |      * @param null|array|\Stripe\Util\RequestOptions $opts
48 |      *
49 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
50 |      *
51 |      * @return \Stripe\Radar\ValueList
52 |      */
53 |     public function delete($id, $params = null, $opts = null)
54 |     {
55 |         return $this->request('delete', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
56 |     }
57 | 
58 |     /**
59 |      * Retrieves a <code>ValueList</code> object.
60 |      *
61 |      * @param string $id
62 |      * @param null|array $params
63 |      * @param null|array|\Stripe\Util\RequestOptions $opts
64 |      *
65 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
66 |      *
67 |      * @return \Stripe\Radar\ValueList
68 |      */
69 |     public function retrieve($id, $params = null, $opts = null)
70 |     {
71 |         return $this->request('get', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
72 |     }
73 | 
74 |     /**
75 |      * Updates a <code>ValueList</code> object by setting the values of the parameters
76 |      * passed. Any parameters not provided will be left unchanged. Note that
77 |      * <code>item_type</code> is immutable.
78 |      *
79 |      * @param string $id
80 |      * @param null|array $params
81 |      * @param null|array|\Stripe\Util\RequestOptions $opts
82 |      *
83 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
84 |      *
85 |      * @return \Stripe\Radar\ValueList
86 |      */
87 |     public function update($id, $params = null, $opts = null)
88 |     {
89 |         return $this->request('post', $this->buildPath('/v1/radar/value_lists/%s', $id), $params, $opts);
90 |     }
91 | }
92 | 


--------------------------------------------------------------------------------
/lib/File.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * This is an object representing a file hosted on Stripe's servers. The file may
 7 |  * have been uploaded by yourself using the <a
 8 |  * href="https://stripe.com/docs/api#create_file">create file</a> request (for
 9 |  * example, when uploading dispute evidence) or it may have been created by Stripe
10 |  * (for example, the results of a <a href="#scheduled_queries">Sigma scheduled
11 |  * query</a>).
12 |  *
13 |  * Related guide: <a href="https://stripe.com/docs/file-upload">File Upload
14 |  * Guide</a>.
15 |  *
16 |  * @property string $id Unique identifier for the object.
17 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
18 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
19 |  * @property null|string $filename A filename for the file, suitable for saving to a filesystem.
20 |  * @property null|\Stripe\Collection $links A list of <a href="https://stripe.com/docs/api#file_links">file links</a> that point at this file.
21 |  * @property string $purpose The purpose of the file. Possible values are <code>additional_verification</code>, <code>business_icon</code>, <code>business_logo</code>, <code>customer_signature</code>, <code>dispute_evidence</code>, <code>finance_report_run</code>, <code>identity_document</code>, <code>pci_document</code>, <code>sigma_scheduled_query</code>, or <code>tax_document_user_upload</code>.
22 |  * @property int $size The size in bytes of the file object.
23 |  * @property null|string $title A user friendly title for the document.
24 |  * @property null|string $type The type of the file returned (e.g., <code>csv</code>, <code>pdf</code>, <code>jpg</code>, or <code>png</code>).
25 |  * @property null|string $url The URL from which the file can be downloaded using your live secret API key.
26 |  */
27 | class File extends ApiResource
28 | {
29 |     const OBJECT_NAME = 'file';
30 | 
31 |     use ApiOperations\All;
32 |     use ApiOperations\Retrieve;
33 | 
34 |     // This resource can have two different object names. In latter API
35 |     // versions, only `file` is used, but since stripe-php may be used with
36 |     // any API version, we need to support deserializing the older
37 |     // `file_upload` object into the same class.
38 |     const OBJECT_NAME_ALT = 'file_upload';
39 | 
40 |     use ApiOperations\Create {
41 |         create as protected _create;
42 |     }
43 | 
44 |     public static function classUrl()
45 |     {
46 |         return '/v1/files';
47 |     }
48 | 
49 |     /**
50 |      * @param null|array $params
51 |      * @param null|array|string $opts
52 |      *
53 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
54 |      *
55 |      * @return \Stripe\File the created file
56 |      */
57 |     public static function create($params = null, $opts = null)
58 |     {
59 |         $opts = \Stripe\Util\RequestOptions::parse($opts);
60 |         if (null === $opts->apiBase) {
61 |             $opts->apiBase = Stripe::$apiUploadBase;
62 |         }
63 |         // Manually flatten params, otherwise curl's multipart encoder will
64 |         // choke on nested arrays.
65 |         $flatParams = \array_column(\Stripe\Util\Util::flattenParams($params), 1, 0);
66 | 
67 |         return static::_create($flatParams, $opts);
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/lib/Review.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Stripe;
 4 | 
 5 | /**
 6 |  * Reviews can be used to supplement automated fraud detection with human
 7 |  * expertise.
 8 |  *
 9 |  * Learn more about <a href="/radar">Radar</a> and reviewing payments <a
10 |  * href="https://stripe.com/docs/radar/reviews">here</a>.
11 |  *
12 |  * @property string $id Unique identifier for the object.
13 |  * @property string $object String representing the object's type. Objects of the same type share the same value.
14 |  * @property null|string $billing_zip The ZIP or postal code of the card used, if applicable.
15 |  * @property null|string|\Stripe\Charge $charge The charge associated with this review.
16 |  * @property null|string $closed_reason The reason the review was closed, or null if it has not yet been closed. One of <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, or <code>disputed</code>.
17 |  * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18 |  * @property null|string $ip_address The IP address where the payment originated.
19 |  * @property null|\Stripe\StripeObject $ip_address_location Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
20 |  * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
21 |  * @property bool $open If <code>true</code>, the review needs action.
22 |  * @property string $opened_reason The reason the review was opened. One of <code>rule</code> or <code>manual</code>.
23 |  * @property string|\Stripe\PaymentIntent $payment_intent The PaymentIntent ID associated with this review, if one exists.
24 |  * @property string $reason The reason the review is currently open or closed. One of <code>rule</code>, <code>manual</code>, <code>approved</code>, <code>refunded</code>, <code>refunded_as_fraud</code>, or <code>disputed</code>.
25 |  * @property null|\Stripe\StripeObject $session Information related to the browsing session of the user who initiated the payment.
26 |  */
27 | class Review extends ApiResource
28 | {
29 |     const OBJECT_NAME = 'review';
30 | 
31 |     use ApiOperations\All;
32 |     use ApiOperations\Retrieve;
33 | 
34 |     /**
35 |      * Possible string representations of the current, the opening or the closure reason of the review.
36 |      * Not all of these enumeration apply to all of the ´reason´ fields. Please consult the Review object to
37 |      * determine where these are apply.
38 |      *
39 |      * @see https://stripe.com/docs/api/radar/reviews/object
40 |      */
41 |     const REASON_APPROVED = 'approved';
42 |     const REASON_DISPUTED = 'disputed';
43 |     const REASON_MANUAL = 'manual';
44 |     const REASON_REFUNDED = 'refunded';
45 |     const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
46 |     const REASON_RULE = 'rule';
47 | 
48 |     /**
49 |      * @param null|array $params
50 |      * @param null|array|string $opts
51 |      *
52 |      * @throws \Stripe\Exception\ApiErrorException if the request fails
53 |      *
54 |      * @return Review the approved review
55 |      */
56 |     public function approve($params = null, $opts = null)
57 |     {
58 |         $url = $this->instanceUrl() . '/approve';
59 |         list($response, $opts) = $this->_request('post', $url, $params, $opts);
60 |         $this->refreshFrom($response, $opts);
61 | 
62 |         return $this;
63 |     }
64 | }
65 | 


--------------------------------------------------------------------------------