ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
PaymentLink.php
71 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * A payment link is a shareable URL that will take your customers to a hosted |
| 9 | * payment page. A payment link can be shared and used multiple times. |
| 10 | * |
| 11 | * When a customer opens a payment link it will open a new <a |
| 12 | * href="https://stripe.com/docs/api/checkout/sessions">checkout session</a> to |
| 13 | * render the payment page. You can use <a |
| 14 | * href="https://stripe.com/docs/api/events/types#event_types-checkout.session.completed">checkout |
| 15 | * session events</a> to track payments through payment links. |
| 16 | * |
| 17 | * Related guide: <a |
| 18 | * href="https://stripe.com/docs/payments/payment-links/api">Payment Links API</a> |
| 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 bool $active Whether the payment link's <code>url</code> is active. If <code>false</code>, customers visiting the URL will be shown a page saying that the link has been deactivated. |
| 23 | * @property \Stripe\StripeObject $after_completion |
| 24 | * @property bool $allow_promotion_codes Whether user redeemable promotion codes are enabled. |
| 25 | * @property null|int $application_fee_amount The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. |
| 26 | * @property null|float $application_fee_percent This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. |
| 27 | * @property \Stripe\StripeObject $automatic_tax |
| 28 | * @property string $billing_address_collection Configuration for collecting the customer's billing address. |
| 29 | * @property \Stripe\Collection<\Stripe\LineItem> $line_items The line items representing what is being sold. |
| 30 | * @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. |
| 31 | * @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. |
| 32 | * @property null|string|\Stripe\Account $on_behalf_of The account on behalf of which to charge. See the <a href="https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts">Connect documentation</a> for details. |
| 33 | * @property null|string[] $payment_method_types The list of payment method types that customers can use. When <code>null</code>, Stripe will dynamically show relevant payment methods you've enabled in your <a href="https://dashboard.stripe.com/settings/payment_methods">payment method settings</a>. |
| 34 | * @property \Stripe\StripeObject $phone_number_collection |
| 35 | * @property null|\Stripe\StripeObject $shipping_address_collection Configuration for collecting the customer's shipping address. |
| 36 | * @property null|\Stripe\StripeObject $subscription_data When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use <code>subscription_data</code>. |
| 37 | * @property null|\Stripe\StripeObject $transfer_data The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. |
| 38 | * @property string $url The public URL that can be shared with customers. |
| 39 | */ |
| 40 | class PaymentLink extends ApiResource |
| 41 | { |
| 42 | const OBJECT_NAME = 'payment_link'; |
| 43 | |
| 44 | use ApiOperations\All; |
| 45 | use ApiOperations\Create; |
| 46 | use ApiOperations\Retrieve; |
| 47 | use ApiOperations\Update; |
| 48 | |
| 49 | const BILLING_ADDRESS_COLLECTION_AUTO = 'auto'; |
| 50 | const BILLING_ADDRESS_COLLECTION_REQUIRED = 'required'; |
| 51 | |
| 52 | /** |
| 53 | * @param null|array $params |
| 54 | * @param null|array|string $opts |
| 55 | * @param mixed $id |
| 56 | * |
| 57 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 58 | * |
| 59 | * @return \Stripe\Collection<\Stripe\PaymentLink> list of LineItems |
| 60 | */ |
| 61 | public static function allLineItems($id, $params = null, $opts = null) |
| 62 | { |
| 63 | $url = static::resourceUrl($id) . '/line_items'; |
| 64 | list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); |
| 65 | $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 66 | $obj->setLastResponse($response); |
| 67 | |
| 68 | return $obj; |
| 69 | } |
| 70 | } |
| 71 |