ModelInvoices module

StripePaymentMethod

Class StripePaymentMethod

A model in the Invoices module, with 15 members for templates, 12 API properties and 22 members for admin templates.

Invoices\Models\Frontend\StripePaymentMethod Invoices\Models\Api\StripePaymentMethod Invoices\Models\Backend\StripePaymentMethod Also in Invoices: Invoice InvoiceCustomFieldValue Item MockPayPaymentMethod PayPalDonatePaymentMethod PayPalPaymentMethod Refund RefundItem Transaction
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 15

Take no arguments.

# getPublishableKey()
string
Get the publishable key, used for frontend integrations
# getAccountId()
?string
Get the account id
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 12

Read-only values on the record.

# publishableKey
string
Get the publishable key, used for frontend integrations
# accountId
?string
Get the account id
# paymentServiceProviderName
string
Get the name of the payment service provider.
# paymentServiceProviderType
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# id
?int
# name
?string
# position
?int
# testMode
bool
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# active
bool
# site
?Site

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 22

Take no arguments.

# getPublishableKey()
string
Get the publishable key, used for frontend integrations
# getAccountId()
?string
Get the account id
# getPaymentServiceProviderName()
string
Get the name of the payment service provider.
# getPaymentServiceProviderType()
string
Get the payment service provider type. Integrators can use this to determine what payment service provider this payment method belongs to.
# getId()
?int
# getName()
?string
# getPosition()
?int
# isTestMode()
bool
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# isActive()
bool
# getSite()
?Site
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# isConnectConfigured() Admin only
bool
Check whether this environment holds the credentials Stripe Connect onboarding needs. Dev and staging environments do not store the live credentials, so offer onboarding only when the link can actually be built.
# getConnectOAuthUrl() Admin only
string
Get the connect OAuth url which begins Stripe connect onboarding
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getMoveUrl() Admin only
?string
Get the url for moving the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getManageUrl() Admin only
?string
Get the url for managing records.