From 9f369358b314b53b37a9af16ac56d74ee866410e Mon Sep 17 00:00:00 2001 From: Olivier Bellone Date: Mon, 24 Feb 2020 15:08:00 -0800 Subject: [PATCH] Codegen for openapi 26a4af3 (#883) --- lib/Account.php | 10 +++++++-- lib/AccountLink.php | 8 ++++++- lib/ApplePayDomain.php | 2 -- lib/ApplicationFee.php | 2 -- lib/Balance.php | 16 ++++++++++++-- lib/BalanceTransaction.php | 8 ++++++- lib/BankAccount.php | 13 +++++++++++- lib/BitcoinReceiver.php | 2 -- lib/Card.php | 7 ++++++- lib/Charge.php | 8 ++++++- lib/Checkout/Session.php | 17 ++++++++++++++- lib/CountrySpec.php | 7 ++++++- lib/Coupon.php | 7 ++++++- lib/CreditNote.php | 6 +++++- lib/Customer.php | 8 ++++++- lib/Dispute.php | 9 +++++++- lib/EphemeralKey.php | 2 -- lib/Event.php | 34 +++++++++++++++++++++++++++++- lib/ExchangeRate.php | 12 ++++++++++- lib/File.php | 12 +++++++++-- lib/FileLink.php | 4 +++- lib/Invoice.php | 36 +++++++++++++++++++++++++++++++- lib/InvoiceItem.php | 9 +++++++- lib/Issuing/Authorization.php | 10 +++++++-- lib/Issuing/Card.php | 3 ++- lib/Issuing/Cardholder.php | 7 ++++++- lib/Issuing/Dispute.php | 7 ++++++- lib/Issuing/Transaction.php | 8 ++++++- lib/Mandate.php | 3 ++- lib/Order.php | 8 ++++++- lib/OrderReturn.php | 8 ++++++- lib/PaymentIntent.php | 16 ++++++++++++-- lib/PaymentMethod.php | 11 +++++++++- lib/Payout.php | 9 +++++++- lib/Plan.php | 9 +++++++- lib/Product.php | 12 ++++++++++- lib/Radar/EarlyFraudWarning.php | 7 ++++++- lib/Radar/ValueList.php | 7 ++++++- lib/Radar/ValueListItem.php | 7 ++++++- lib/Recipient.php | 14 ++++++++++++- lib/Refund.php | 6 +++++- lib/Reporting/ReportRun.php | 11 +++++++++- lib/Reporting/ReportType.php | 11 +++++++++- lib/Review.php | 6 +++++- lib/SKU.php | 12 ++++++++++- lib/SetupIntent.php | 24 ++++++++++++++++++++- lib/Sigma/ScheduledQueryRun.php | 6 +++++- lib/Source.php | 8 ++++++- lib/Subscription.php | 6 +++++- lib/SubscriptionItem.php | 5 +++-- lib/SubscriptionSchedule.php | 7 ++++++- lib/TaxRate.php | 5 ++++- lib/Terminal/ConnectionToken.php | 6 +++++- lib/Terminal/Location.php | 6 +++++- lib/Terminal/Reader.php | 6 +++++- lib/ThreeDSecure.php | 6 ++++-- lib/Token.php | 32 +++++++++++++++++++++++++--- lib/Topup.php | 9 ++++++-- lib/Transfer.php | 13 +++++++++++- lib/WebhookEndpoint.php | 11 +++++++++- 60 files changed, 507 insertions(+), 74 deletions(-) diff --git a/lib/Account.php b/lib/Account.php index 34acb43d3..79a009b47 100644 --- a/lib/Account.php +++ b/lib/Account.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class Account. + * This is an object representing a Stripe account. You can retrieve it to see + * properties on the account like its current e-mail address or if the account is + * enabled yet to make live charges. + * + * Some properties, marked below, are available only to platforms that want to create and manage Express or + * Custom accounts. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. @@ -18,7 +24,7 @@ * @property bool $details_submitted Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. * @property null|string $email The primary user's email address. * @property \Stripe\Collection $external_accounts External accounts (bank accounts and debit cards) currently attached to this account - * @property \Stripe\Person $individual + * @property \Stripe\Person $individual

This is an object representing a person associated with a Stripe account.

Related guide: Handling Identity Verification with the API.

* @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. * @property bool $payouts_enabled Whether Stripe can send payouts to this account. * @property \Stripe\StripeObject $requirements diff --git a/lib/AccountLink.php b/lib/AccountLink.php index 79929f6e1..4b0f9ec83 100644 --- a/lib/AccountLink.php +++ b/lib/AccountLink.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class AccountLink. + * Account Links are the means by which a Connect platform grants a connected + * account permission to access Stripe-hosted applications, such as Connect + * Onboarding. + * + * Related guide: Connect + * Onboarding. * * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. diff --git a/lib/ApplePayDomain.php b/lib/ApplePayDomain.php index 75323abe2..011aafce3 100644 --- a/lib/ApplePayDomain.php +++ b/lib/ApplePayDomain.php @@ -3,8 +3,6 @@ namespace Stripe; /** - * Class ApplePayDomain. - * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. diff --git a/lib/ApplicationFee.php b/lib/ApplicationFee.php index 1e157fa15..4df3a0867 100644 --- a/lib/ApplicationFee.php +++ b/lib/ApplicationFee.php @@ -3,8 +3,6 @@ namespace Stripe; /** - * Class ApplicationFee. - * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property string|\Stripe\Account $account ID of the Stripe account this fee was taken from. diff --git a/lib/Balance.php b/lib/Balance.php index 0df4eab50..4b4d2d613 100644 --- a/lib/Balance.php +++ b/lib/Balance.php @@ -3,10 +3,22 @@ namespace Stripe; /** - * Class Balance. + * This is an object representing your Stripe balance. You can retrieve it to see + * the balance currently on your Stripe account. + * + * You can also retrieve the balance history, which contains a list of transactions + * that contributed to the balance (charges, payouts, and so forth). + * + * The available and pending amounts for each currency are broken down further by + * payment source types. + * + * Related guide: Understanding Connect + * Account Balances. * * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property. + * @property \Stripe\StripeObject[] $available Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property. * @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 source_types property. * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. * @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 source_types property. diff --git a/lib/BalanceTransaction.php b/lib/BalanceTransaction.php index 5bc98f33f..ebe01bea3 100644 --- a/lib/BalanceTransaction.php +++ b/lib/BalanceTransaction.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class BalanceTransaction. + * Balance transactions represent funds moving through your Stripe account. They're + * created for every type of transaction that comes into or flows out of your + * Stripe account balance. + * + * Related guide: Balance + * Transaction Types. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/BankAccount.php b/lib/BankAccount.php index 8994fd588..56a1a2605 100644 --- a/lib/BankAccount.php +++ b/lib/BankAccount.php @@ -3,7 +3,18 @@ namespace Stripe; /** - * Class BankAccount. + * These bank accounts are payment methods on Customer objects. + * + * On the other hand External Accounts are + * transfer destinations on Account objects for Custom accounts. They + * can be bank accounts or debit cards as well, and are documented in the links + * above. + * + * Related guide: Processing ACH & + * Bank Transfers. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/BitcoinReceiver.php b/lib/BitcoinReceiver.php index 155d42057..3fe212c09 100644 --- a/lib/BitcoinReceiver.php +++ b/lib/BitcoinReceiver.php @@ -3,8 +3,6 @@ namespace Stripe; /** - * Class BitcoinReceiver. - * * @deprecated Bitcoin receivers are deprecated. Please use the sources API instead. * @see https://stripe.com/docs/sources/bitcoin * diff --git a/lib/Card.php b/lib/Card.php index 6e27276eb..694220f66 100644 --- a/lib/Card.php +++ b/lib/Card.php @@ -3,7 +3,12 @@ namespace Stripe; /** - * Class Card. + * 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. + * + * Related guide: Card Payments + * with Sources. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Charge.php b/lib/Charge.php index 3b3e92745..2ed38bf19 100644 --- a/lib/Charge.php +++ b/lib/Charge.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class Charge. + * To charge a credit or a debit card, you create a Charge object. You + * can retrieve and refund individual charges as well as list all charges. Charges + * are identified by a unique, random ID. + * + * Related guide: Accept a + * payment with the Charges API. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Checkout/Session.php b/lib/Checkout/Session.php index c9b6c5566..1a45a241a 100644 --- a/lib/Checkout/Session.php +++ b/lib/Checkout/Session.php @@ -3,7 +3,22 @@ namespace Stripe\Checkout; /** - * Class Session. + * A Checkout Session represents your customer's session as they pay for one-time + * purchases or subscriptions through Checkout. We recommend + * creating a new Session each time your customer attempts to pay. + * + * Once payment is successful, the Checkout Session will contain a reference to the + * Customer, and either the + * successful PaymentIntent or an + * active Subscription. + * + * You can create a Checkout Session on your server and pass its ID to the client + * to begin Checkout. + * + * Related guide: Checkout + * Server Quickstart. * * @property string $id Unique identifier for the object. Used to pass to redirectToCheckout in Stripe.js. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/CountrySpec.php b/lib/CountrySpec.php index ea0eb342e..5779d407d 100644 --- a/lib/CountrySpec.php +++ b/lib/CountrySpec.php @@ -3,7 +3,12 @@ namespace Stripe; /** - * Class CountrySpec. + * Stripe needs to collect certain pieces of information about each account + * created. These requirements can differ depending on the account's country. The + * Country Specs API makes these rules available to your integration. + * + * You can also view the information from this API call as an online guide. * * @property string $id Unique identifier for the object. Represented as the ISO country code for this country. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Coupon.php b/lib/Coupon.php index ea3b8c073..b4bf515c6 100644 --- a/lib/Coupon.php +++ b/lib/Coupon.php @@ -3,7 +3,12 @@ namespace Stripe; /** - * Class Coupon. + * A coupon contains information about a percent-off or amount-off discount you + * might want to apply to a customer. Coupons may be applied to invoices or orders. Coupons do + * not work with conventional one-off charges. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/CreditNote.php b/lib/CreditNote.php index a96e5263e..dbe7cc9a4 100644 --- a/lib/CreditNote.php +++ b/lib/CreditNote.php @@ -3,7 +3,11 @@ namespace Stripe; /** - * Class CreditNote. + * Issue a credit note to adjust an invoice's amount after the invoice is + * finalized. + * + * Related guide: Credit Notes. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Customer.php b/lib/Customer.php index 525c825a7..229b53ff7 100644 --- a/lib/Customer.php +++ b/lib/Customer.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class Customer. + * Customer objects allow you to perform recurring charges, and to + * track multiple charges, that are associated with the same customer. The API + * allows you to create, delete, and update your customers. You can retrieve + * individual customers as well as a list of all your customers. + * + * Related guide: Saving Cards with + * Customers. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Dispute.php b/lib/Dispute.php index 48e3daeac..7d3c56ca5 100644 --- a/lib/Dispute.php +++ b/lib/Dispute.php @@ -3,7 +3,14 @@ namespace Stripe; /** - * Class Dispute. + * A dispute occurs when a customer questions your charge with their card issuer. + * When this happens, you're given the opportunity to respond to the dispute with + * evidence that shows that the charge is legitimate. You can find more information + * about the dispute process in our Disputes and Fraud + * documentation. + * + * Related guide: Disputes and + * Fraud. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/EphemeralKey.php b/lib/EphemeralKey.php index c2275457a..ff33f24ce 100644 --- a/lib/EphemeralKey.php +++ b/lib/EphemeralKey.php @@ -3,8 +3,6 @@ namespace Stripe; /** - * Class EphemeralKey. - * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. diff --git a/lib/Event.php b/lib/Event.php index 4999418ff..8702c8ee8 100644 --- a/lib/Event.php +++ b/lib/Event.php @@ -3,7 +3,39 @@ namespace Stripe; /** - * Class Event. + * Events are our way of letting you know when something interesting happens in + * your account. When an interesting event occurs, we create a new + * Event object. For example, when a charge succeeds, we create a + * charge.succeeded event; and when an invoice payment attempt fails, + * we create an invoice.payment_failed event. Note that many API + * requests may cause multiple events to be created. For example, if you create a + * new subscription for a customer, you will receive both a + * customer.subscription.created event and a + * charge.succeeded event. + * + * Events occur when the state of another API resource changes. The state of that + * resource at the time of the change is embedded in the event's data field. For + * example, a charge.succeeded event will contain a charge, and an + * invoice.payment_failed event will contain an invoice. + * + * As with other API resources, you can use endpoints to retrieve an individual event or a list of events from the API. + * We also have a separate webhooks system for sending the + * Event objects directly to an endpoint on your server. Webhooks are + * managed in your account + * settings, and our Using + * Webhooks guide will help you get set up. + * + * When using Connect, you can also + * receive notifications of events that occur in connected accounts. For these + * events, there will be an additional account attribute in the + * received Event object. + * + * NOTE: Right now, access to events through the Retrieve Event API is + * guaranteed only for 30 days. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/ExchangeRate.php b/lib/ExchangeRate.php index 39482b48e..ba66c7a69 100644 --- a/lib/ExchangeRate.php +++ b/lib/ExchangeRate.php @@ -3,7 +3,17 @@ namespace Stripe; /** - * Class ExchangeRate. + * Exchange Rate objects allow you to determine the rates that Stripe + * is currently using to convert from one currency to another. Since this number is + * variable throughout the day, there are various reasons why you might want to + * know the current rate (for example, to dynamically price an item for a user with + * a default payment in a foreign currency). + * + * If you want a guarantee that the charge is made with a certain exchange rate you + * expect is current, you can pass in exchange_rate to charges + * endpoints. If the value is no longer up to date, the charge won't go through. + * Please refer to our Exchange + * Rates API guide for more details. * * @property string $id Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/File.php b/lib/File.php index c85f58c67..9f16608f5 100644 --- a/lib/File.php +++ b/lib/File.php @@ -3,13 +3,21 @@ namespace Stripe; /** - * Class File. + * This is an object representing a file hosted on Stripe's servers. The file may + * have been uploaded by yourself using the create file request (for + * example, when uploading dispute evidence) or it may have been created by Stripe + * (for example, the results of a Sigma scheduled + * query). + * + * Related guide: File Upload + * Guide. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property null|string $filename A filename for the file, suitable for saving to a filesystem. - * @property null|\Stripe\Collection $links A list of file links that point at this file. + * @property null|\Stripe\Collection $links A list of file links that point at this file. * @property string $purpose The purpose of the file. Possible values are additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload. * @property int $size The size in bytes of the file object. * @property null|string $title A user friendly title for the document. diff --git a/lib/FileLink.php b/lib/FileLink.php index 7da35fade..a953fde4f 100644 --- a/lib/FileLink.php +++ b/lib/FileLink.php @@ -3,7 +3,9 @@ namespace Stripe; /** - * Class FileLink. + * To share the contents of a File object with non-Stripe users, you + * can create a FileLink. FileLinks contain a URL that + * can be used to retrieve the contents of the file without authentication. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Invoice.php b/lib/Invoice.php index 1ce90ccfd..289838da0 100644 --- a/lib/Invoice.php +++ b/lib/Invoice.php @@ -3,7 +3,41 @@ namespace Stripe; /** - * Class Invoice. + * Invoices are statements of amounts owed by a customer, and are either generated + * one-off, or generated periodically from a subscription. + * + * They contain invoice + * items, and proration adjustments that may be caused by subscription + * upgrades/downgrades (if necessary). + * + * If your invoice is configured to be billed through automatic charges, Stripe + * automatically finalizes your invoice and attempts payment. Note that finalizing + * the invoice, when + * automatic, does not happen immediately as the invoice is created. Stripe + * waits until one hour after the last webhook was successfully sent (or the last + * webhook timed out after failing). If you (and the platforms you may have + * connected to) have no webhooks configured, Stripe waits one hour after creation + * to finalize the invoice. + * + * If your invoice is configured to be billed by sending an email, then based on + * your email + * settings, Stripe will email the invoice to your customer and await payment. + * These emails can contain a link to a hosted page to pay the invoice. + * + * Stripe applies any customer credit on the account before determining the amount + * due for the invoice (i.e., the amount that will be actually charged). If the + * amount due for the invoice is less than Stripe's minimum allowed + * charge per currency, the invoice is automatically marked paid, and we add + * the amount due to the customer's running account balance which is applied to the + * next invoice. + * + * More details on the customer's account balance are here. + * + * Related guide: Send + * Invoices to Customers. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/InvoiceItem.php b/lib/InvoiceItem.php index 553443dd3..7bf9bf249 100644 --- a/lib/InvoiceItem.php +++ b/lib/InvoiceItem.php @@ -3,7 +3,14 @@ namespace Stripe; /** - * Class InvoiceItem. + * Sometimes you want to add a charge or credit to a customer, but actually charge + * or credit the customer's card only at the end of a regular billing cycle. This + * is useful for combining several charges (to minimize per-transaction fees), or + * for having Stripe tabulate your usage-based billing totals. + * + * Related guide: Subscription + * Invoices. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Issuing/Authorization.php b/lib/Issuing/Authorization.php index 50ac53395..92068179d 100644 --- a/lib/Issuing/Authorization.php +++ b/lib/Issuing/Authorization.php @@ -3,7 +3,13 @@ namespace Stripe\Issuing; /** - * Class Authorization. + * When an issued card is used to + * make a purchase, an Issuing Authorization object is created. Authorizations must be + * approved for the purchase to be completed successfully. + * + * Related guide: Issued + * Card Authorizations. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. @@ -12,7 +18,7 @@ * @property int $authorized_amount The amount that has been authorized. This will be 0 when the object is created, and increase after it has been approved. * @property string $authorized_currency The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property \Stripe\BalanceTransaction[] $balance_transactions List of balance transactions associated with this authorization. - * @property \Stripe\Issuing\Card $card + * @property \Stripe\Issuing\Card $card You can create physical or virtual cards that are issued to cardholders. * @property null|string|\Stripe\Issuing\Cardholder $cardholder The cardholder to whom this authorization belongs. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property int $held_amount The amount the authorization is expected to be in held_currency. When Stripe holds funds from you, this is the amount reserved for the authorization. This will be 0 when the object is created, and increase after it has been approved. For multi-currency transactions, held_amount can be used to determine the expected exchange rate. diff --git a/lib/Issuing/Card.php b/lib/Issuing/Card.php index dc775a79b..891338725 100644 --- a/lib/Issuing/Card.php +++ b/lib/Issuing/Card.php @@ -3,7 +3,8 @@ namespace Stripe\Issuing; /** - * Class Card. + * You can create physical or + * virtual cards that are issued to cardholders. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Issuing/Cardholder.php b/lib/Issuing/Cardholder.php index cbe55ba2d..258467047 100644 --- a/lib/Issuing/Cardholder.php +++ b/lib/Issuing/Cardholder.php @@ -3,7 +3,12 @@ namespace Stripe\Issuing; /** - * Class Cardholder. + * An Issuing Cardholder object represents an individual or business + * entity who is issued cards. + * + * Related guide: How to create a + * Cardholder * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Issuing/Dispute.php b/lib/Issuing/Dispute.php index 26498fa12..1a60255a3 100644 --- a/lib/Issuing/Dispute.php +++ b/lib/Issuing/Dispute.php @@ -3,7 +3,12 @@ namespace Stripe\Issuing; /** - * Class Dispute. + * As a card issuer, you can dispute transactions that + * you do not recognize, suspect to be fraudulent, or have some other issue. + * + * Related guide: Disputing + * Transactions * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Issuing/Transaction.php b/lib/Issuing/Transaction.php index 353a2e946..f8ec46423 100644 --- a/lib/Issuing/Transaction.php +++ b/lib/Issuing/Transaction.php @@ -3,7 +3,13 @@ namespace Stripe\Issuing; /** - * Class Transaction. + * Any use of an issued card that + * results in funds entering or leaving your Stripe account, such as a completed + * purchase or refund, is represented by an Issuing Transaction + * object. + * + * Related guide: Issued + * Card Transactions. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Mandate.php b/lib/Mandate.php index 04795bd50..57a86046d 100644 --- a/lib/Mandate.php +++ b/lib/Mandate.php @@ -3,7 +3,8 @@ namespace Stripe; /** - * Class Mandate. + * A Mandate is a record of the permission a customer has given you to debit their + * payment method. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Order.php b/lib/Order.php index 2fc4eadd7..fdd2eb920 100644 --- a/lib/Order.php +++ b/lib/Order.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class Order. + * Order objects are created to handle end customers' purchases of previously + * defined products. You can + * create, retrieve, and pay individual orders, as well as list all orders. Orders + * are identified by a unique, random ID. + * + * Related guide: Tax, Shipping, and + * Inventory. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/OrderReturn.php b/lib/OrderReturn.php index 617428126..1a0f57ce6 100644 --- a/lib/OrderReturn.php +++ b/lib/OrderReturn.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class OrderReturn. + * A return represents the full or partial return of a number of order items. Returns always + * belong to an order, and may optionally contain a refund. + * + * Related guide: Handling + * Returns. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/PaymentIntent.php b/lib/PaymentIntent.php index 6cde9d525..ec8893176 100644 --- a/lib/PaymentIntent.php +++ b/lib/PaymentIntent.php @@ -3,7 +3,19 @@ namespace Stripe; /** - * Class PaymentIntent. + * A PaymentIntent guides you through the process of collecting a payment from your + * customer. We recommend that you create exactly one PaymentIntent for each order + * or customer session in your system. You can reference the PaymentIntent later to + * see the history of payment attempts for a particular session. + * + * A PaymentIntent transitions through multiple + * statuses throughout its lifetime as it interfaces with Stripe.js to perform + * authentication flows and ultimately creates at most one successful charge. + * + * Related guide: Payment + * Intents API. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. @@ -33,7 +45,7 @@ * @property string[] $payment_method_types The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. * @property null|string $receipt_email Email address that the receipt for the resulting payment will be sent to. * @property null|string|\Stripe\Review $review ID of the review associated with this PaymentIntent, if any. - * @property null|string $setup_future_usage

Indicates that you intend to make future payments with this PaymentIntent's payment method.

If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes.

For more, learn to save card details after a payment.

Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.

+ * @property null|string $setup_future_usage

Indicates that you intend to make future payments with this PaymentIntent's payment method.

If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes.

For more, learn to save card details during payment.

Stripe uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using off_session will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.

* @property null|\Stripe\StripeObject $shipping Shipping information for this PaymentIntent. * @property null|string|\Stripe\StripeObject $source This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied. * @property null|string $statement_descriptor For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. diff --git a/lib/PaymentMethod.php b/lib/PaymentMethod.php index ad5e2bf78..0d5aabd6c 100644 --- a/lib/PaymentMethod.php +++ b/lib/PaymentMethod.php @@ -3,7 +3,16 @@ namespace Stripe; /** - * Class PaymentMethod. + * PaymentMethod objects represent your customer's payment instruments. They can be + * used with PaymentIntents to + * collect payments or saved to Customer objects to store instrument details for + * future payments. + * + * Related guides: Payment Methods and + * More Payment + * Scenarios. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Payout.php b/lib/Payout.php index 3393f1f52..15c24f905 100644 --- a/lib/Payout.php +++ b/lib/Payout.php @@ -3,7 +3,14 @@ namespace Stripe; /** - * Class Payout. + * A Payout object is created when you receive funds from Stripe, or + * when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve + * individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your + * country and industry. + * + * Related guide: Receiving Payouts. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Plan.php b/lib/Plan.php index 5e691014f..9af246dac 100644 --- a/lib/Plan.php +++ b/lib/Plan.php @@ -3,7 +3,14 @@ namespace Stripe; /** - * Class Plan. + * Plans define the base price, currency, and billing cycle for subscriptions. For + * example, you might have a <currency>5</currency>/month plan that + * provides limited access to your products, and a + * <currency>15</currency>/month plan that allows full access. + * + * Related guide: Managing + * Products and Plans. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Product.php b/lib/Product.php index 88ba4638a..a0addcfb4 100644 --- a/lib/Product.php +++ b/lib/Product.php @@ -3,7 +3,17 @@ namespace Stripe; /** - * Class Product. + * Store representations of products you sell in Product objects, used + * in conjunction with SKUs. + * Products may be physical goods, to be shipped, or digital. + * + * Documentation on Products for use with Subscriptions + * can be found at Subscription Products. + * + * Related guide: Define products and + * SKUs * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Radar/EarlyFraudWarning.php b/lib/Radar/EarlyFraudWarning.php index 70e834a6b..b46955ec0 100644 --- a/lib/Radar/EarlyFraudWarning.php +++ b/lib/Radar/EarlyFraudWarning.php @@ -3,7 +3,12 @@ namespace Stripe\Radar; /** - * Class EarlyFraudWarning. + * An early fraud warning indicates that the card issuer has notified us that a + * charge may be fraudulent. + * + * Related guide: Early + * Fraud Warnings. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Radar/ValueList.php b/lib/Radar/ValueList.php index b6783621c..649fa0bde 100644 --- a/lib/Radar/ValueList.php +++ b/lib/Radar/ValueList.php @@ -3,7 +3,12 @@ namespace Stripe\Radar; /** - * Class ValueList. + * Value lists allow you to group values together which can then be referenced in + * rules. + * + * Related guide: Default Stripe + * Lists. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Radar/ValueListItem.php b/lib/Radar/ValueListItem.php index 8bf5ce873..01f6a0102 100644 --- a/lib/Radar/ValueListItem.php +++ b/lib/Radar/ValueListItem.php @@ -3,7 +3,12 @@ namespace Stripe\Radar; /** - * Class ValueListItem. + * Value list items allow you to add specific values to a given Radar value list, + * which can then be used in rules. + * + * Related guide: Managing List + * Items. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Recipient.php b/lib/Recipient.php index 68e5f856e..d0317de63 100644 --- a/lib/Recipient.php +++ b/lib/Recipient.php @@ -3,7 +3,19 @@ namespace Stripe; /** - * Class Recipient. + * With Recipient objects, you can transfer money from your Stripe + * account to a third-party bank account or debit card. The API allows you to + * create, delete, and update your recipients. You can retrieve individual + * recipients as well as a list of all your recipients. + * + * Recipient objects have been deprecated in favor of Connect, specifically Connect's much + * more powerful Account objects. + * Stripe accounts that don't already use recipients can no longer begin doing so. + * Please use Account objects instead. If you are already using + * recipients, please see our migration + * guide for more information. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Refund.php b/lib/Refund.php index bda42f739..0549e4aa8 100644 --- a/lib/Refund.php +++ b/lib/Refund.php @@ -3,7 +3,11 @@ namespace Stripe; /** - * Class Refund. + * Refund objects allow you to refund a charge that has previously + * been created but not yet refunded. Funds will be refunded to the credit or debit + * card that was originally charged. + * + * Related guide: Refunds. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Reporting/ReportRun.php b/lib/Reporting/ReportRun.php index 03467a2e3..17339f28a 100644 --- a/lib/Reporting/ReportRun.php +++ b/lib/Reporting/ReportRun.php @@ -3,7 +3,16 @@ namespace Stripe\Reporting; /** - * Class ReportRun. + * The Report Run object represents an instance of a report type generated with + * specific run parameters. Once the object is created, Stripe begins processing + * the report. When the report has finished running, it will give you a reference + * to a file where you can retrieve your results. For an overview, see API Access to + * Reports. + * + * Note that reports can only be run based on your live-mode data (not test-mode + * data), and thus related requests must be made with a live-mode API key. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Reporting/ReportType.php b/lib/Reporting/ReportType.php index d34b8cb5d..bc1c124ac 100644 --- a/lib/Reporting/ReportType.php +++ b/lib/Reporting/ReportType.php @@ -3,7 +3,16 @@ namespace Stripe\Reporting; /** - * Class ReportType. + * The Report Type resource corresponds to a particular type of report, such as the + * "Activity summary" or "Itemized payouts" reports. These + * objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports + * documentation for those Report Type IDs, along with required and optional + * parameters. + * + * Note that reports can only be run based on your live-mode data (not test-mode + * data), and thus related requests must be made with a live-mode API key. * * @property string $id The ID of the Report Type, such as balance.summary.1. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Review.php b/lib/Review.php index 0364e0074..0ea305e35 100644 --- a/lib/Review.php +++ b/lib/Review.php @@ -3,7 +3,11 @@ namespace Stripe; /** - * Class Review. + * Reviews can be used to supplement automated fraud detection with human + * expertise. + * + * Learn more about Radar and reviewing payments here. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/SKU.php b/lib/SKU.php index 7d61ac6d8..c7f852384 100644 --- a/lib/SKU.php +++ b/lib/SKU.php @@ -3,7 +3,17 @@ namespace Stripe; /** - * Class SKU. + * Stores representations of stock keeping units. + * SKUs describe specific product variations, taking into account any combination + * of: attributes, currency, and cost. For example, a product may be a T-shirt, + * whereas a specific SKU represents the size: large, color: + * red version of that shirt. + * + * Can also be used to manage inventory. + * + * Related guide: Tax, Shipping, and + * Inventory. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/SetupIntent.php b/lib/SetupIntent.php index 359be6536..40e7a071c 100644 --- a/lib/SetupIntent.php +++ b/lib/SetupIntent.php @@ -3,7 +3,29 @@ namespace Stripe; /** - * Class SetupIntent. + * A SetupIntent guides you through the process of setting up a customer's payment + * credentials for future payments. For example, you could use a SetupIntent to set + * up your customer's card without immediately collecting a payment. Later, you can + * use PaymentIntents to + * drive the payment flow. + * + * Create a SetupIntent as soon as you're ready to collect your customer's payment + * credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no + * longer be valid. The SetupIntent then transitions through multiple statuses as + * it guides you through the setup process. + * + * Successful SetupIntents result in payment credentials that are optimized for + * future payments. For example, cardholders in certain regions may need to be + * run through Strong Customer + * Authentication at the time of payment method collection in order to + * streamline later off-session payments. + * + * By using SetupIntents, you ensure that your customers experience the minimum set + * of required friction, even as regulations change over time. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Sigma/ScheduledQueryRun.php b/lib/Sigma/ScheduledQueryRun.php index cfdd25f34..8ff3ad782 100644 --- a/lib/Sigma/ScheduledQueryRun.php +++ b/lib/Sigma/ScheduledQueryRun.php @@ -3,7 +3,11 @@ namespace Stripe\Sigma; /** - * Class ScheduledQueryRun. + * If you have scheduled + * a Sigma query, you'll receive a + * sigma.scheduled_query_run.created webhook each time the query runs. + * The webhook contains a ScheduledQueryRun object, which you can use + * to retrieve the query results. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Source.php b/lib/Source.php index 3d76b3e33..a402e89e5 100644 --- a/lib/Source.php +++ b/lib/Source.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class Source. + * Source objects allow you to accept a variety of payment methods. + * They represent a customer's payment instrument, and can be used with the Stripe + * API just like a Card object: once chargeable, they can be charged, + * or can be attached to customers. + * + * Related guides: Sources API and Sources & Customers. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Subscription.php b/lib/Subscription.php index 3830230c4..e2e35531c 100644 --- a/lib/Subscription.php +++ b/lib/Subscription.php @@ -3,7 +3,11 @@ namespace Stripe; /** - * Class Subscription. + * Subscriptions allow you to charge a customer on a recurring basis. + * + * Related guide: Creating + * Subscriptions. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/SubscriptionItem.php b/lib/SubscriptionItem.php index a8ff1f3eb..cfa12d4ba 100644 --- a/lib/SubscriptionItem.php +++ b/lib/SubscriptionItem.php @@ -3,14 +3,15 @@ namespace Stripe; /** - * Class SubscriptionItem. + * Subscription items allow you to create customer subscriptions with more than one + * plan, making it easy to represent complex billing relationships. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property null|\Stripe\StripeObject $billing_thresholds Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - * @property \Stripe\Plan $plan + * @property \Stripe\Plan $plan

Plans define the base price, currency, and billing cycle for subscriptions. For example, you might have a <currency>5</currency>/month plan that provides limited access to your products, and a <currency>15</currency>/month plan that allows full access.

Related guide: Managing Products and Plans.

* @property int $quantity The quantity of the plan to which the customer should be subscribed. * @property string $subscription The subscription this subscription_item belongs to. * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item. diff --git a/lib/SubscriptionSchedule.php b/lib/SubscriptionSchedule.php index 53add60e3..a5619caad 100644 --- a/lib/SubscriptionSchedule.php +++ b/lib/SubscriptionSchedule.php @@ -3,7 +3,12 @@ namespace Stripe; /** - * Class SubscriptionSchedule. + * A subscription schedule allows you to create and manage the lifecycle of a + * subscription by predefining expected changes. + * + * Related guide: Subscription + * Schedules. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/TaxRate.php b/lib/TaxRate.php index 57df63284..375aa0dca 100644 --- a/lib/TaxRate.php +++ b/lib/TaxRate.php @@ -3,7 +3,10 @@ namespace Stripe; /** - * Class TaxRate. + * Tax rates can be applied to invoices and subscriptions to collect tax. + * + * Related guide: Tax + * Rates. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Terminal/ConnectionToken.php b/lib/Terminal/ConnectionToken.php index 16571e0cc..c238aefac 100644 --- a/lib/Terminal/ConnectionToken.php +++ b/lib/Terminal/ConnectionToken.php @@ -3,7 +3,11 @@ namespace Stripe\Terminal; /** - * Class ConnectionToken. + * A Connection Token is used by the Stripe Terminal SDK to connect to a reader. + * + * Related guide: Fleet + * Management. * * @property string $object String representing the object's type. Objects of the same type share the same value. * @property string $location The id of the location that this connection token is scoped to. diff --git a/lib/Terminal/Location.php b/lib/Terminal/Location.php index 92e38ab11..429d2877e 100644 --- a/lib/Terminal/Location.php +++ b/lib/Terminal/Location.php @@ -3,7 +3,11 @@ namespace Stripe\Terminal; /** - * Class Location. + * A Location represents a grouping of readers. + * + * Related guide: Fleet + * Management. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/Terminal/Reader.php b/lib/Terminal/Reader.php index 2b480ee91..b55176f7d 100644 --- a/lib/Terminal/Reader.php +++ b/lib/Terminal/Reader.php @@ -3,7 +3,11 @@ namespace Stripe\Terminal; /** - * Class Reader. + * A Reader represents a physical device for accepting payment details. + * + * Related guide: Connecting to a + * Reader. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/ThreeDSecure.php b/lib/ThreeDSecure.php index 4b353b84b..d7e306226 100644 --- a/lib/ThreeDSecure.php +++ b/lib/ThreeDSecure.php @@ -3,13 +3,15 @@ namespace Stripe; /** - * Class ThreeDSecure. + * Cardholder authentication via 3D Secure is initiated by creating a 3D + * Secure object. Once the object has been created, you can use it to + * authenticate the cardholder and create a charge. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property int $amount Amount of the charge that you will create when authentication completes. * @property bool $authenticated True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. - * @property \Stripe\Card $card + * @property \Stripe\Card $card

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.

Related guide: Card Payments with Sources.

* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. diff --git a/lib/Token.php b/lib/Token.php index edfedde0b..5268bf852 100644 --- a/lib/Token.php +++ b/lib/Token.php @@ -3,12 +3,38 @@ namespace Stripe; /** - * Class Token. + * Tokenization is the process Stripe uses to collect sensitive card or bank + * account details, or personally identifiable information (PII), directly from + * your customers in a secure manner. A token representing this information is + * returned to your server to use. You should use our recommended payments integrations to + * perform this process client-side. This ensures that no sensitive card data + * touches your server, and allows your integration to operate in a PCI-compliant + * way. + * + * If you cannot use client-side tokenization, you can also create tokens using the + * API with either your publishable or secret API key. Keep in mind that if your + * integration uses this method, you are responsible for any PCI compliance that + * may be required, and you must keep your secret API key safe. Unlike with + * client-side tokenization, your customer's information is not sent directly to + * Stripe, so we cannot determine how it is handled or stored. + * + * Tokens cannot be stored or used more than once. To store card or bank account + * information for later use, you can create Customer objects or Custom accounts. Note + * that Radar, our integrated solution + * for automatic fraud protection, supports only integrations that use client-side + * tokenization. + * + * Related guide: Accept + * a payment * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. - * @property \Stripe\BankAccount $bank_account - * @property \Stripe\Card $card + * @property \Stripe\BankAccount $bank_account

These bank accounts are payment methods on Customer objects.

On the other hand External Accounts are transfer destinations on Account objects for Custom accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

Related guide: Processing ACH & Bank Transfers.

+ * @property \Stripe\Card $card

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.

Related guide: Card Payments with Sources.

* @property null|string $client_ip IP address of the client that generated the token. * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. diff --git a/lib/Topup.php b/lib/Topup.php index 84e3a22b4..660b2c383 100644 --- a/lib/Topup.php +++ b/lib/Topup.php @@ -3,7 +3,12 @@ namespace Stripe; /** - * Class Topup. + * To top up your Stripe balance, you create a top-up object. You can retrieve + * individual top-ups, as well as list all top-ups. Top-ups are identified by a + * unique, random ID. + * + * Related guide: Topping Up your + * Platform Account. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. @@ -17,7 +22,7 @@ * @property null|string $failure_message Message to user further explaining reason for top-up failure if available. * @property bool $livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode. * @property \Stripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - * @property \Stripe\Source $source + * @property \Stripe\Source $source

Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

Related guides: Sources API and Sources & Customers.

* @property null|string $statement_descriptor Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. * @property string $status The status of the top-up is either canceled, failed, pending, reversed, or succeeded. * @property null|string $transfer_group A string that identifies this top-up as part of a group. diff --git a/lib/Transfer.php b/lib/Transfer.php index 45e16f6a3..64949f79d 100644 --- a/lib/Transfer.php +++ b/lib/Transfer.php @@ -3,7 +3,18 @@ namespace Stripe; /** - * Class Transfer. + * A Transfer object is created when you move funds between Stripe + * accounts as part of Connect. + * + * Before April 6, 2017, transfers also represented movement of funds from a Stripe + * account to a card or bank account. This behavior has since been split out into a + * Payout object, with + * corresponding payout endpoints. For more information, read about the transfer/payout split. + * + * Related guide: Creating Separate + * Charges and Transfers. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. diff --git a/lib/WebhookEndpoint.php b/lib/WebhookEndpoint.php index 09c796ab8..94a152c53 100644 --- a/lib/WebhookEndpoint.php +++ b/lib/WebhookEndpoint.php @@ -3,7 +3,16 @@ namespace Stripe; /** - * Class WebhookEndpoint. + * You can configure webhook + * endpoints via the API to be notified about events that happen in your Stripe + * account or connected accounts. + * + * Most users configure webhooks from the dashboard, which provides a + * user interface for registering and testing your webhook endpoints. + * + * Related guide: Setting up + * Webhooks. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value.