A
Arrayable Class in namespace Bulldog\Strype\Contracts\Support Amount Class in namespace Bulldog\Strype\Models\Coupons An amount object requires the amount off, and the currency. $Amount #amountProperty in class Amount
Amount Class in namespace Bulldog\Strype\Models\InvoiceItems Invoice Item Amount. $Amount #amountProperty in class Amount
$Product #argumentsProperty in class Product
B
BalanceInterface Class in namespace Bulldog\Strype\Contracts\Resources BusinessLogo Class in namespace Bulldog\Strype\Models\Files Business Logo. Balance Class in namespace Bulldog\Strype\Resources This is an object representing your Stripe balance. You can retrieve it to see
the balance currently on your Stripe account. Strype ::balanceMethod in class Strype C
CouponTypeInterface Class in namespace Bulldog\Strype\Contracts\Models ChargeInterface Class in namespace Bulldog\Strype\Contracts\Resources Interface CustomerInterface. ChargeInterface ::createMethod in class ChargeInterface ChargeInterface ::captureMethod in class ChargeInterface CouponInterface Class in namespace Bulldog\Strype\Contracts\Resources CouponInterface ::createMethod in class CouponInterface CustomerInterface Class in namespace Bulldog\Strype\Contracts\Resources CustomerInterface ::createMethod in class CustomerInterface CustomerInterface ::createWithoutTokenMethod in class CustomerInterface DisputeInterface ::closeMethod in class DisputeInterface FileInterface ::createMethod in class FileInterface FileLinkInterface ::createMethod in class FileLinkInterface InvoiceInterface ::createMethod in class InvoiceInterface InvoiceItemInterface ::createMethod in class InvoiceItemInterface PaymentIntentInterface ::createMethod in class PaymentIntentInterface PaymentIntentInterface ::confirmMethod in class PaymentIntentInterface PaymentIntentInterface ::captureMethod in class PaymentIntentInterface PaymentIntentInterface ::cancelMethod in class PaymentIntentInterface PayoutInterface ::createMethod in class PayoutInterface PayoutInterface ::cancelMethod in class PayoutInterface PlanInterface ::createMethod in class PlanInterface ProductInterface ::createMethod in class ProductInterface RefundInterface ::createMethod in class RefundInterface SubscriptionInterface ::createMethod in class SubscriptionInterface SubscriptionInterface ::cancelMethod in class SubscriptionInterface SubscriptionItemInterface ::createMethod in class SubscriptionItemInterface TokenInterface ::createCardMethod in class TokenInterface TokenInterface ::createBankAccountMethod in class TokenInterface TokenInterface ::createPiiMethod in class TokenInterface TokenInterface ::createAccountMethod in class TokenInterface UsageRecordInterface ::createMethod in class UsageRecordInterface $Amount #currencyProperty in class Amount
$Percent #currencyProperty in class Percent
CustomerSignature Class in namespace Bulldog\Strype\Models\Files Customer Signature. ChargeAutomatically Class in namespace Bulldog\Strype\Models\Subscriptions Charge the subscription automatically. Charge Class in namespace Bulldog\Strype\Resources 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. Charge ::createMethod in class Charge Charge a Customer. A Customer must have some sort of payment source. Usually
they payment source is a card, and it is added via a token that is created
using JavaScript on the front end. This helps keep your application PCI
compliant. Charge ::captureMethod in class Charge Capture the payment of an existing, uncaptured, charge. This is the second
half of the two-step payment flow, where first you created a charge with
the capture option set to false. Coupon Class in namespace Bulldog\Strype\Resources 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. Coupon ::createMethod in class Coupon A coupon has either a percent_off or an amount_off and currency. If you set
an amount_off, that amount will be subtracted from any invoice’s subtotal. Customer Class in namespace Bulldog\Strype\Resources 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. Customer ::createMethod in class Customer Create a customer. Customer ::createWithoutTokenMethod in class Customer Create a Customer without requiring a token. Discount ::customerMethod in class Discount Dispute ::closeMethod in class Dispute Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially
dismissing the dispute, acknowledging it as lost. File ::createMethod in class File Create a file. FileLink ::createMethod in class FileLink Creates a new file link object. Invoice ::createMethod in class Invoice This endpoint creates a draft invoice for a given customer. The draft
invoice created pulls in all pending invoice items on that customer,
including prorations. InvoiceItem ::createMethod in class InvoiceItem Creates an item to be added to a draft invoice. If no invoice is specified,
the item will be on the next invoice created for the customer specified. PaymentIntent ::createMethod in class PaymentIntent Creates a PaymentIntent object. PaymentIntent ::confirmMethod in class PaymentIntent Confirm that your customer intends to pay with current or provided source. PaymentIntent ::captureMethod in class PaymentIntent Capture the funds of an existing uncaptured PaymentIntent where
required_action="requires_capture". PaymentIntent ::cancelMethod in class PaymentIntent A PaymentIntent object can be canceled when it is in one of these statues:
requires_source, requires_capture, requires_confirmation, or
requires_source_action. Payout ::createMethod in class Payout To send funds to your own bank account, you create a new payout object. Payout ::cancelMethod in class Payout A previously created payout can be canceled if it has not yet been paid
out. Funds will be refunded to your available balance. You may not cancel
automatic Stripe payouts. Plan ::createMethod in class Plan You can create plans using the API, or in the Stripe Dashboard. Product ::createMethod in class Product Creates a new product object. To create a product for use with orders, see Products. Refund ::createMethod in class Refund When you create a new refund, you must specify a charge on which to create it. Subscription ::createMethod in class Subscription Creates a new subscription on an existing customer. Subscription ::cancelMethod in class Subscription Cancels a customer’s subscription immediately. The customer will not be
charged again for the subscription. SubscriptionItem ::createMethod in class SubscriptionItem Adds a new item to an existing subscription. No existing items will be changed or replaced. Token ::createCardMethod in class Token Creates a single-use token that represents a credit card’s details. This
token can be used in place of a credit card associative array with any API
method. These tokens can be used only once: by creating a new Charge object,
or by attaching them to a Customer object. Token ::createBankAccountMethod in class Token Creates a single-use token that represents a bank account’s details. This
token can be used in place of a bank account associative array with any
API method. These tokens can be used only once: by attaching them to a
recipient or Custom account. Token ::createPiiMethod in class Token Creates a single-use token that represents the details of personally
identifiable information (PII). This token can be used in place of a
personal_id_number in the Account Update API method. A PII token can
be used only once. Token ::createAccountMethod in class Token Creates a single-use token that wraps a user’s legal entity information. UsageRecord ::createMethod in class UsageRecord Creates a usage record for a specified subscription item and date, and
fills it with a quantity. Strype ::customerMethod in class Strype Strype ::chargeMethod in class Strype Strype ::couponMethod in class Strype D
DurationTypeInterface Class in namespace Bulldog\Strype\Contracts\Models DiscountInterface Class in namespace Bulldog\Strype\Contracts\Resources DiscountInterface ::deleteCustomerDiscountMethod in class DiscountInterface DiscountInterface ::deleteSubscriptionDiscountMethod in class DiscountInterface DisputeInterface Class in namespace Bulldog\Strype\Contracts\Resources DeleteInterface Class in namespace Bulldog\Strype\Contracts\Traits Interface DeleteInterface. DeleteInterface ::deleteMethod in class DeleteInterface $Repeating #durationProperty in class Repeating
DisputeEvidence Class in namespace Bulldog\Strype\Models\Files Dispute Evidence. $SendInvoice #daysUntilDueProperty in class SendInvoice
Discount Class in namespace Bulldog\Strype\Resources A discount represents the actual application of a coupon to a particular customer. Discount ::deleteCustomerDiscountMethod in class Discount Removes the currently applied discount on a customer. Discount ::deleteSubscriptionDiscountMethod in class Discount Removes the currently applied discount on a subscription. Dispute Class in namespace Bulldog\Strype\Resources A dispute occurs when a customer questions your charge with their card issuer. Strype ::disputeMethod in class Strype Strype ::discountMethod in class Strype Delete Class in namespace Bulldog\Strype\Traits Delete. Delete ::deleteMethod in class Delete Delete a resource. E
EventInterface Class in namespace Bulldog\Strype\Contracts\Resources Event Class in namespace Bulldog\Strype\Resources 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. Strype ::eventMethod in class Strype F
FileTypeInterface Class in namespace Bulldog\Strype\Contracts\Models FileInterface Class in namespace Bulldog\Strype\Contracts\Resources FileLinkInterface Class in namespace Bulldog\Strype\Contracts\Resources InvoiceInterface ::finalizeInvoiceMethod in class InvoiceInterface Forever Class in namespace Bulldog\Strype\Models\Durations Used for indicating the duration is forever. File Class in namespace Bulldog\Strype\Models Base File class. $File #fileProperty in class File
File Class in namespace Bulldog\Strype\Resources 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). FileLink Class in namespace Bulldog\Strype\Resources 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. Invoice ::finalizeInvoiceMethod in class Invoice Stripe automatically finalizes drafts before sending and attempting payment
on invoices. However, if you’d like to finalize a draft invoice manually,
you can do so using this method. Strype ::fileMethod in class Strype Strype ::fileLinkMethod in class Strype G
FileTypeInterface ::getFileMethod in class FileTypeInterface FileTypeInterface ::getPurposeMethod in class FileTypeInterface Identifiable ::getIdMethod in class Identifiable File ::getFileMethod in class File Returns the stream resource. File ::getPurposeMethod in class File Returns the purpose of the file. Good Class in namespace Bulldog\Strype\Models\Products Product is a good. Resource ::getIdMethod in class Resource Returns the unique identifier for this resource. Resource ::getResponseMethod in class Resource Returns the raw Stripe response. I
InvoiceItemTypeInterface Class in namespace Bulldog\Strype\Contracts\Models InvoiceInterface Class in namespace Bulldog\Strype\Contracts\Resources InvoiceItemInterface Class in namespace Bulldog\Strype\Contracts\Resources Identifiable Class in namespace Bulldog\Strype\Contracts\Support IdentityDocument Class in namespace Bulldog\Strype\Models\Files Identity Document. $Resource #idProperty in class Resource
A unique identifier for the resource. Invoice Class in namespace Bulldog\Strype\Resources Invoices are statements of amounts owed by a customer, and are either generated
one-off, or generated periodically from a subscription. InvoiceItem Class in namespace Bulldog\Strype\Resources 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. Strype ::invoiceItemMethod in class Strype Strype ::invoiceMethod in class Strype L
ListAllInterface Class in namespace Bulldog\Strype\Contracts\Traits ListAllInterface ::listAllMethod in class ListAllInterface ListAll Class in namespace Bulldog\Strype\Traits List All. ListAll ::listAllMethod in class ListAll List all the resources. M
InvoiceInterface ::markUncollectibleMethod in class InvoiceInterface Invoice ::markUncollectibleMethod in class Invoice Marking an invoice as uncollectible is useful for keeping track of bad
debts that can be written off for accounting purposes. N
$Product #nameProperty in class Product
O
Once Class in namespace Bulldog\Strype\Models\Durations Duration is once. P
ProductTypeInterface Class in namespace Bulldog\Strype\Contracts\Models InvoiceInterface ::payMethod in class InvoiceInterface PaymentIntentInterface Class in namespace Bulldog\Strype\Contracts\Resources PayoutInterface Class in namespace Bulldog\Strype\Contracts\Resources PlanInterface Class in namespace Bulldog\Strype\Contracts\Resources ProductInterface Class in namespace Bulldog\Strype\Contracts\Resources Percent Class in namespace Bulldog\Strype\Models\Coupons A Percent object only requires the percentage. $Percent #percentageProperty in class Percent
$File #purposeProperty in class File
PciDocument Class in namespace Bulldog\Strype\Models\Files PCI Document. Product Class in namespace Bulldog\Strype\Models Base Product class. Invoice ::payMethod in class Invoice Stripe automatically creates and then attempts to collect payment on
invoices for customers on subscriptions according to your subscriptions
settings. However, if you’d like to attempt payment on an invoice out of
the normal collection schedule or for some other reason, you can do so. PaymentIntent Class in namespace Bulldog\Strype\Resources A PaymentIntent tracks the process of collecting a payment from your customer. Payout Class in namespace Bulldog\Strype\Resources 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. Plan Class in namespace Bulldog\Strype\Resources Plans define the base price, currency, and billing cycle for subscriptions. Product Class in namespace Bulldog\Strype\Resources Product objects describe items that your customers can subscribe to with a
Subscription. An associated Plan determines the product pricing. Strype ::payoutMethod in class Strype Strype ::productMethod in class Strype Strype ::planMethod in class Strype Strype ::paymentIntentMethod in class Strype Q
Quantity Class in namespace Bulldog\Strype\Models\InvoiceItems Invoice Item Quantity. $Quantity #quantityProperty in class Quantity
R
ResourceInterface Class in namespace Bulldog\Strype\Contracts BalanceInterface ::retrieveBalanceTransactionMethod in class BalanceInterface InvoiceInterface ::retrieveLineItemsMethod in class InvoiceInterface InvoiceInterface ::retrieveUpcomingLineItemsMethod in class InvoiceInterface RefundInterface Class in namespace Bulldog\Strype\Contracts\Resources RetrieveInterface Class in namespace Bulldog\Strype\Contracts\Traits Interface RetrieveInterface. RetrieveInterface ::retrieveMethod in class RetrieveInterface Repeating Class in namespace Bulldog\Strype\Models\Durations Duration repeats every X months. Resource Class in namespace Bulldog\Strype Class Resource. $Resource #responseProperty in class Resource
A response from Stripe. Balance ::retrieveMethod in class Balance Retrieves the current account balance, based on the authentication that
was used to make the request. Balance ::retrieveBalanceTransactionMethod in class Balance Retrieves the balance transaction with the given ID. Invoice ::retrieveLineItemsMethod in class Invoice When retrieving an invoice, you’ll get a lines property containing the
total count of line items and the first handful of those items. There
is also a URL where you can retrieve the full (paginated) list of
line items. Invoice ::retrieveUpcomingLineItemsMethod in class Invoice When retrieving an upcoming invoice, you’ll get a lines property containing
the total count of line items and the first handful of those items. There is
also a URL where you can retrieve the full (paginated) list of line items. Refund Class in namespace Bulldog\Strype\Resources 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. Strype ::refundMethod in class Strype Retrieve Class in namespace Bulldog\Strype\Traits Retrieve. Retrieve ::retrieveMethod in class Retrieve Get a resource by the ID. S
SubscriptionBillingTypeInterface Class in namespace Bulldog\Strype\Contracts\Models InvoiceInterface ::sendInvoiceMethod in class InvoiceInterface SubscriptionInterface Class in namespace Bulldog\Strype\Contracts\Resources SubscriptionItemInterface Class in namespace Bulldog\Strype\Contracts\Resources Service Class in namespace Bulldog\Strype\Models\Products Product is a service. SendInvoice Class in namespace Bulldog\Strype\Models\Subscriptions Send an invoice for the subscription. Resource ::setPropertiesMethod in class Resource Set the response data as properties on the class. Charge ::stripeMethod in class Charge Call the Stripe API. Coupon ::stripeMethod in class Coupon Customer ::stripeMethod in class Customer Discount ::subscriptionMethod in class Discount Dispute ::stripeMethod in class Dispute Event ::stripeMethod in class Event File ::stripeMethod in class File FileLink ::stripeMethod in class FileLink Invoice ::sendInvoiceMethod in class Invoice Stripe will automatically send invoices to customers according to your
subscriptions settings. However, if you’d like to manually send an invoice
to your customer out of the normal schedule, you can do so. When sending
invoices that have already been paid, there will be no reference to the
payment in the email. Invoice ::stripeMethod in class Invoice InvoiceItem ::stripeMethod in class InvoiceItem PaymentIntent ::stripeMethod in class PaymentIntent Payout ::stripeMethod in class Payout Plan ::stripeMethod in class Plan Product ::stripeMethod in class Product Refund ::stripeMethod in class Refund Subscription Class in namespace Bulldog\Strype\Resources Subscriptions allow you to charge a customer on a recurring basis. A subscription
ties a customer to a particular plan you've created. Subscription ::stripeMethod in class Subscription SubscriptionItem Class in namespace Bulldog\Strype\Resources Subscription items allow you to create customer subscriptions with more than
one plan, making it easy to represent complex billing relationships. SubscriptionItem ::stripeMethod in class SubscriptionItem Token ::stripeMethod in class Token UsageRecord ::stripeMethod in class UsageRecord Strype Class in namespace Bulldog\Strype Class Strype. Strype ::subscriptionMethod in class Strype Strype ::subscriptionItemMethod in class Strype T
TokenInterface Class in namespace Bulldog\Strype\Contracts\Resources Arrayable ::toArrayMethod in class Arrayable Amount ::toArrayMethod in class Amount Return an associative array with the protected properties. Percent ::toArrayMethod in class Percent Return an associative array with the values of the properties. Forever ::toArrayMethod in class Forever Once ::toArrayMethod in class Once Repeating ::toArrayMethod in class Repeating TaxDocumentUserUpload Class in namespace Bulldog\Strype\Models\Files Tax Document. Amount ::toArrayMethod in class Amount Quantity ::toArrayMethod in class Quantity $Product #typeProperty in class Product
Product ::toArrayMethod in class Product $Good #typeProperty in class Good
$Service #typeProperty in class Service
ChargeAutomatically ::toArrayMethod in class ChargeAutomatically SendInvoice ::toArrayMethod in class SendInvoice Token Class in namespace Bulldog\Strype\Resources 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 Checkout, Elements, or our mobile libraries 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. Strype ::tokenMethod in class Strype U
InvoiceInterface ::upcomingMethod in class InvoiceInterface UsageRecordInterface Class in namespace Bulldog\Strype\Contracts\Resources UsageRecordInterface ::usageRecordSummariesMethod in class UsageRecordInterface UpdateInterface Class in namespace Bulldog\Strype\Contracts\Traits Interface UpdateInterface. UpdateInterface ::updateMethod in class UpdateInterface $Repeating #unitsProperty in class Repeating
$Quantity #unitAmountProperty in class Quantity
Invoice ::upcomingMethod in class Invoice At any time, you can preview the upcoming invoice for a customer. This will
show you all the charges that are pending, including subscription renewal
charges, invoice item charges, etc. It will also show you any discount
that is applicable to the customer. UsageRecord Class in namespace Bulldog\Strype\Resources Usage records allow you to report customer usage and metrics to Stripe for
metered billing of subscription plans. UsageRecord ::usageRecordSummariesMethod in class UsageRecord For the specified subscription item, returns a list of summary objects. Strype ::usageRecordMethod in class Strype Update Class in namespace Bulldog\Strype\Traits Update. Update ::updateMethod in class Update Update a resource. V
InvoiceInterface ::voidInvoiceMethod in class InvoiceInterface Invoice ::voidInvoiceMethod in class Invoice Mark a finalized invoice as void. This cannot be undone. Voiding an invoice
is similar to deletion, however it only applies to finalized invoices and
maintains a papertrail where the invoice can still be found. _
Amount ::__constructMethod in class Amount Create an amount object with currency. Percent ::__constructMethod in class Percent Create a percent object with currency. Repeating ::__constructMethod in class Repeating BusinessLogo ::__constructMethod in class BusinessLogo CustomerSignature ::__constructMethod in class CustomerSignature DisputeEvidence ::__constructMethod in class DisputeEvidence IdentityDocument ::__constructMethod in class IdentityDocument PciDocument ::__constructMethod in class PciDocument TaxDocumentUserUpload ::__constructMethod in class TaxDocumentUserUpload Amount ::__constructMethod in class Amount Quantity ::__constructMethod in class Quantity Product ::__constructMethod in class Product SendInvoice ::__constructMethod in class SendInvoice Strype ::__constructMethod in class Strype Strype constructor.