diff --git a/lib/ApplicationFeeRefund.php b/lib/ApplicationFeeRefund.php index b25ec503e..b432a88a6 100644 --- a/lib/ApplicationFeeRefund.php +++ b/lib/ApplicationFeeRefund.php @@ -3,16 +3,22 @@ namespace Stripe; /** - * Class ApplicationFeeRefund. + * Application Fee Refund objects allow you to refund an application + * fee that has previously been created but not yet refunded. Funds will be + * refunded to the Stripe account from which the fee was originally collected. * - * @property string $id - * @property string $object - * @property int $amount - * @property string $balance_transaction - * @property int $created - * @property string $currency - * @property string $fee - * @property \Stripe\StripeObject $metadata + * Related guide: Refunding + * Application Fees. + * + * @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, in %s. + * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance. + * @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 string|\Stripe\ApplicationFee $fee ID of the application fee that was refunded. + * @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. */ class ApplicationFeeRefund extends ApiResource { diff --git a/lib/BitcoinTransaction.php b/lib/BitcoinTransaction.php index 1e96c680c..c552e258c 100644 --- a/lib/BitcoinTransaction.php +++ b/lib/BitcoinTransaction.php @@ -3,7 +3,13 @@ namespace Stripe; /** - * Class BitcoinTransaction. + * @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 The amount of currency that the transaction was converted to in real-time. + * @property int $bitcoin_amount The amount of bitcoin contained in the transaction. + * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property string $currency Three-letter ISO code for the currency to which this transaction was converted. + * @property string $receiver The receiver to which this transaction was sent. */ class BitcoinTransaction extends ApiResource { diff --git a/lib/Capability.php b/lib/Capability.php index 0a72ba852..2d791eecb 100644 --- a/lib/Capability.php +++ b/lib/Capability.php @@ -3,15 +3,19 @@ namespace Stripe; /** - * Class Capability. + * This is an object representing a capability for a Stripe account. * - * @property string $id - * @property string $object - * @property string $account - * @property bool $requested - * @property int $requested_at + * Related guide: Capabilities + * Overview. + * + * @property string $id The identifier for the capability. + * @property string $object String representing the object's type. Objects of the same type share the same value. + * @property string|\Stripe\Account $account The account for which the capability enables functionality. + * @property bool $requested Whether the capability has been requested. + * @property null|int $requested_at Time at which the capability was requested. Measured in seconds since the Unix epoch. * @property \Stripe\StripeObject $requirements - * @property string $status + * @property string $status The status of the capability. Can be active, inactive, pending, or unrequested. */ class Capability extends ApiResource { diff --git a/lib/CustomerBalanceTransaction.php b/lib/CustomerBalanceTransaction.php index d3f40f51c..d8d42a8ce 100644 --- a/lib/CustomerBalanceTransaction.php +++ b/lib/CustomerBalanceTransaction.php @@ -3,21 +3,31 @@ namespace Stripe; /** - * Class CustomerBalanceTransaction. + * Each customer has a balance + * value, which denotes a debit or credit that's automatically applied to their + * next invoice upon finalization. You may modify the value directly by using the + * update customer API, + * or by creating a Customer Balance Transaction, which increments or decrements + * the customer's balance by the specified amount. * - * @property string $id - * @property string $object - * @property int $amount - * @property string $credit_note - * @property int $created - * @property string $currency - * @property string $customer - * @property string $description - * @property int $ending_balance - * @property string $invoice - * @property bool $livemode - * @property \Stripe\StripeObject $metadata - * @property string $type + * Related guide: Customer Balance to + * learn more. + * + * @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 The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's balance. + * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property null|string|\Stripe\CreditNote $credit_note The ID of the credit note (if any) related to the transaction. + * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. + * @property string|\Stripe\Customer $customer The ID of the customer the transaction belongs to. + * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property int $ending_balance The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. + * @property null|string|\Stripe\Invoice $invoice The ID of the invoice (if any) related to the transaction. + * @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 null|\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 string $type Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. See the Customer Balance page to learn more about transaction types. */ class CustomerBalanceTransaction extends ApiResource { diff --git a/lib/InvoiceLineItem.php b/lib/InvoiceLineItem.php index 6da4e871f..03b1f0230 100644 --- a/lib/InvoiceLineItem.php +++ b/lib/InvoiceLineItem.php @@ -3,26 +3,25 @@ namespace Stripe; /** - * Class InvoiceLineItem. - * - * @property string $id - * @property string $object - * @property int $amount - * @property string $currency - * @property string $description - * @property bool $discountable - * @property string $invoice_item - * @property bool $livemode - * @property \Stripe\StripeObject $metadata + * @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 The amount, in %s. + * @property string $currency Three-letter ISO currency code, in lowercase. Must be a supported currency. + * @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. + * @property bool $discountable If true, discounts will apply to this line item. Always false for prorations. + * @property string $invoice_item The ID of the invoice item associated with this line item if any. + * @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. Note that for line items with type=subscription this will reflect the metadata of the subscription that caused the line item to be created. * @property \Stripe\StripeObject $period - * @property \Stripe\Plan $plan - * @property bool $proration - * @property int $quantity - * @property string $subscription - * @property string $subscription_item - * @property array $tax_amounts - * @property array $tax_rates - * @property string $type + * @property null|\Stripe\Plan $plan The plan of the subscription, if the line item is a subscription or a proration. + * @property bool $proration Whether this is a proration. + * @property null|int $quantity The quantity of the subscription, if the line item is a subscription or a proration. + * @property null|string $subscription The subscription that the invoice item pertains to, if any. + * @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. + * @property null|\Stripe\StripeObject[] $tax_amounts The amount of tax calculated per tax rate for this line item + * @property null|\Stripe\TaxRate[] $tax_rates The tax rates which apply to the line item. + * @property string $type A string identifying the type of the source of this line item, either an invoiceitem or a subscription. + * @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. */ class InvoiceLineItem extends ApiResource { diff --git a/lib/LoginLink.php b/lib/LoginLink.php index f7b83bf5d..6000ae62d 100644 --- a/lib/LoginLink.php +++ b/lib/LoginLink.php @@ -3,11 +3,9 @@ namespace Stripe; /** - * Class LoginLink. - * - * @property string $object - * @property int $created - * @property string $url + * @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 string $url The URL for the login link. */ class LoginLink extends ApiResource { diff --git a/lib/Person.php b/lib/Person.php index 6220607e8..89ab2094e 100644 --- a/lib/Person.php +++ b/lib/Person.php @@ -3,32 +3,35 @@ namespace Stripe; /** - * Class Person. + * This is an object representing a person associated with a Stripe account. * - * @property string $id - * @property string $object - * @property string $account + * Related guide: Handling + * Identity Verification with the 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. + * @property string $account The account the person is associated with. * @property \Stripe\StripeObject $address - * @property null|\Stripe\StripeObject $address_kana - * @property null|\Stripe\StripeObject $address_kanji - * @property int $created - * @property bool $deleted + * @property null|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only). + * @property null|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only). + * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. * @property \Stripe\StripeObject $dob - * @property null|string $email - * @property null|string $first_name - * @property null|string $first_name_kana - * @property null|string $first_name_kanji - * @property null|string $gender - * @property bool $id_number_provided - * @property null|string $last_name - * @property null|string $last_name_kana - * @property null|string $last_name_kanji - * @property null|string $maiden_name - * @property \Stripe\StripeObject $metadata - * @property null|string $phone + * @property null|string $email The person's email address. + * @property null|string $first_name The person's first name. + * @property null|string $first_name_kana The Kana variation of the person's first name (Japan only). + * @property null|string $first_name_kanji The Kanji variation of the person's first name (Japan only). + * @property null|string $gender The person's gender (International regulations require either "male" or "female"). + * @property bool $id_number_provided Whether the person's id_number was provided. + * @property null|string $last_name The person's last name. + * @property null|string $last_name_kana The Kana variation of the person's last name (Japan only). + * @property null|string $last_name_kanji The Kanji variation of the person's last name (Japan only). + * @property null|string $maiden_name The person's maiden name. + * @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 null|string $phone The person's phone number. * @property \Stripe\StripeObject $relationship - * @property null|\Stripe\StripeObject $requirements - * @property bool $ssn_last_4_provided + * @property null|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when. + * @property bool $ssn_last_4_provided Whether the last 4 digits of this person's SSN have been provided. * @property \Stripe\StripeObject $verification */ class Person extends ApiResource diff --git a/lib/TaxId.php b/lib/TaxId.php index 2ec9f15c2..474083ad3 100644 --- a/lib/TaxId.php +++ b/lib/TaxId.php @@ -3,16 +3,21 @@ namespace Stripe; /** - * Class TaxId. + * You can add one or multiple tax IDs to a customer. A customer's tax IDs + * are displayed on invoices and credit notes issued for the customer. * - * @property string $id - * @property string $object - * @property string $country - * @property int $created - * @property string $customer - * @property bool $livemode - * @property string $type - * @property string $value + * Related guide: Customer + * Tax Identification Numbers. + * + * @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|string $country Two-letter ISO code representing the country of the tax ID. + * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. + * @property string|\Stripe\Customer $customer ID of the customer. + * @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 string $type Type of the tax ID, one of au_abn, ca_bn, ca_qst, ch_vat, es_cif, eu_vat, hk_br, in_gst, jp_cn, kr_brn, li_uid, mx_rfc, my_itn, my_sst, no_vat, nz_gst, ru_inn, sg_uen, th_vat, tw_vat, us_ein, or za_vat. Note that some legacy tax IDs have type unknown + * @property string $value Value of the tax ID. * @property \Stripe\StripeObject $verification */ class TaxId extends ApiResource diff --git a/lib/TransferReversal.php b/lib/TransferReversal.php index f2eea3860..5aaf07674 100644 --- a/lib/TransferReversal.php +++ b/lib/TransferReversal.php @@ -3,18 +3,33 @@ namespace Stripe; /** - * Class TransferReversal. + * Stripe Connect platforms can + * reverse transfers made to a connected account, either entirely or partially, and + * can also specify whether to refund any related application fees. Transfer + * reversals add to the platform's balance and subtract from the destination + * account's balance. * - * @property string $id - * @property string $object - * @property int $amount - * @property string $balance_transaction - * @property int $created - * @property string $currency - * @property string $destination_payment_refund - * @property \Stripe\StripeObject $metadata - * @property string $source_refund - * @property string $transfer + * Reversing a transfer that was made for a destination charge is allowed only + * up to the amount of the charge. It is possible to reverse a transfer_group + * transfer only if the destination account has enough balance to cover the + * reversal. + * + * Related guide: Reversing + * 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. + * @property int $amount Amount, in %s. + * @property null|string|\Stripe\BalanceTransaction $balance_transaction Balance transaction that describes the impact on your account balance. + * @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 null|string|\Stripe\Refund $destination_payment_refund Linked payment refund for the transfer reversal. + * @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 null|string|\Stripe\Refund $source_refund ID of the refund responsible for the transfer reversal. + * @property string|\Stripe\Transfer $transfer ID of the transfer that was reversed. */ class TransferReversal extends ApiResource { diff --git a/lib/UsageRecord.php b/lib/UsageRecord.php index 34af0066b..ef2a7f372 100644 --- a/lib/UsageRecord.php +++ b/lib/UsageRecord.php @@ -3,14 +3,19 @@ namespace Stripe; /** - * Class UsageRecord. + * Usage records allow you to report customer usage and metrics to Stripe for + * metered billing of subscription plans. * - * @property string $id - * @property string $object - * @property bool $livemode - * @property int $quantity - * @property string $subscription_item - * @property int $timestamp + * Related guide: Metered + * Billing. + * + * @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 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 int $quantity The usage quantity for the specified date. + * @property string $subscription_item The ID of the subscription item this usage record contains data for. + * @property int $timestamp The timestamp when this usage occurred. */ class UsageRecord extends ApiResource { diff --git a/lib/UsageRecordSummary.php b/lib/UsageRecordSummary.php index 0fba0d706..2162c67d4 100644 --- a/lib/UsageRecordSummary.php +++ b/lib/UsageRecordSummary.php @@ -3,15 +3,13 @@ namespace Stripe; /** - * Class UsageRecord. - * - * @property string $id - * @property string $object - * @property string $invoice - * @property bool $livemode + * @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|string $invoice The invoice in which this usage period has been billed for. + * @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 $period - * @property string $subscription_item - * @property int $total_usage + * @property string $subscription_item The ID of the subscription item this summary is describing. + * @property int $total_usage The total usage within this usage period. */ class UsageRecordSummary extends ApiResource {