Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Updates #1220

Merged
merged 1 commit into from
Dec 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/Coupon.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* 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 <a
* href="https://stripe.com/docs/api#invoices">invoices</a> or <a
* href="https://stripe.com/docs/api#create_order-coupon">orders</a>. Coupons do
* not work with conventional one-off <a
* href="https://stripe.com/docs/api#create_order_legacy-coupon">orders</a>.
* Coupons do not work with conventional one-off <a
* href="https://stripe.com/docs/api#create_charge">charges</a>.
*
* @property string $id Unique identifier for the object.
Expand Down
6 changes: 2 additions & 4 deletions lib/Customer.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@
namespace Stripe;

/**
* <code>Customer</code> 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.
* This object represents a customer of your business. It lets you create recurring
* charges and track payments that belong to the same customer.
*
* Related guide: <a
* href="https://stripe.com/docs/payments/save-during-payment">Save a card during
Expand Down
2 changes: 1 addition & 1 deletion lib/PromotionCode.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property bool $active Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
* @property string $code The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
* @property \Stripe\Coupon $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 <a href="https://stripe.com/docs/api#invoices">invoices</a> or <a href="https://stripe.com/docs/api#create_order-coupon">orders</a>. Coupons do not work with conventional one-off <a href="https://stripe.com/docs/api#create_charge">charges</a>.
* @property \Stripe\Coupon $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 <a href="https://stripe.com/docs/api#invoices">invoices</a> or <a href="https://stripe.com/docs/api#create_order_legacy-coupon">orders</a>. Coupons do not work with conventional one-off <a href="https://stripe.com/docs/api#create_charge">charges</a>.
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property null|string|\Stripe\Customer $customer The customer that this promotion code can be used by.
* @property null|int $expires_at Date at which the promotion code can no longer be redeemed.
Expand Down
3 changes: 1 addition & 2 deletions lib/Service/CustomerService.php
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,7 @@ public function deleteTaxId($parentId, $id, $params = null, $opts = null)
}

/**
* Retrieves the details of an existing customer. You need only supply the unique
* customer identifier that was returned upon customer creation.
* Retrieves a Customer object.
*
* @param string $id
* @param null|array $params
Expand Down
5 changes: 4 additions & 1 deletion lib/Service/PromotionCodeService.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ public function create($params = null, $opts = null)
}

/**
* Retrieves the promotion code with the given ID.
* Retrieves the promotion code with the given ID. In order to retrieve a promotion
* code by the customer-facing <code>code</code> use <a
* href="/docs/api/promotion_codes/list">list</a> with the desired
* <code>code</code>.
*
* @param string $id
* @param null|array $params
Expand Down