ApiOperations
1 year ago
Apps
1 year ago
Billing
1 year ago
BillingPortal
1 year ago
Checkout
1 year ago
Climate
1 year ago
Entitlements
1 year ago
EventData
1 year ago
Events
1 year ago
Exception
1 year ago
FinancialConnections
1 year ago
Forwarding
1 year ago
HttpClient
1 year ago
Identity
1 year ago
Issuing
1 year ago
Radar
1 year ago
Reporting
1 year ago
Service
1 year ago
Sigma
1 year ago
Tax
1 year ago
Terminal
1 year ago
TestHelpers
1 year ago
Treasury
1 year ago
Util
1 year ago
V2
1 year ago
Account.php
1 year ago
AccountLink.php
1 year ago
AccountSession.php
1 year ago
ApiRequestor.php
1 year ago
ApiResource.php
2 years ago
ApiResponse.php
2 years ago
ApplePayDomain.php
1 year ago
Application.php
2 years ago
ApplicationFee.php
1 year ago
ApplicationFeeRefund.php
2 years ago
Balance.php
1 year ago
BalanceTransaction.php
1 year ago
BankAccount.php
1 year ago
BaseStripeClient.php
1 year ago
BaseStripeClientInterface.php
1 year ago
Capability.php
1 year ago
Card.php
1 year ago
CashBalance.php
2 years ago
Charge.php
1 year ago
Collection.php
1 year ago
ConfirmationToken.php
1 year ago
ConnectCollectionTransfer.php
2 years ago
CountrySpec.php
1 year ago
Coupon.php
1 year ago
CreditNote.php
1 year ago
CreditNoteLineItem.php
1 year ago
Customer.php
1 year ago
CustomerBalanceTransaction.php
2 years ago
CustomerCashBalanceTransaction.php
2 years ago
CustomerSession.php
1 year ago
Discount.php
1 year ago
Dispute.php
1 year ago
EphemeralKey.php
1 year ago
ErrorObject.php
1 year ago
Event.php
1 year ago
ExchangeRate.php
1 year ago
File.php
1 year ago
FileLink.php
1 year ago
FundingInstructions.php
2 years ago
Invoice.php
1 year ago
InvoiceItem.php
1 year ago
InvoiceLineItem.php
1 year ago
InvoiceRenderingTemplate.php
1 year ago
LineItem.php
1 year ago
LoginLink.php
1 year ago
Mandate.php
1 year ago
OAuth.php
2 years ago
OAuthErrorObject.php
1 year ago
PaymentIntent.php
1 year ago
PaymentLink.php
1 year ago
PaymentMethod.php
1 year ago
PaymentMethodConfiguration.php
1 year ago
PaymentMethodDomain.php
1 year ago
Payout.php
1 year ago
Person.php
1 year ago
Plan.php
1 year ago
Price.php
1 year ago
Product.php
1 year ago
ProductFeature.php
1 year ago
PromotionCode.php
1 year ago
Quote.php
1 year ago
Reason.php
1 year ago
RecipientTransfer.php
2 years ago
Refund.php
1 year ago
RelatedObject.php
1 year ago
RequestTelemetry.php
2 years ago
ReserveTransaction.php
2 years ago
Review.php
1 year ago
SearchResult.php
1 year ago
SetupAttempt.php
1 year ago
SetupIntent.php
1 year ago
ShippingRate.php
1 year ago
SingletonApiResource.php
2 years ago
Source.php
1 year ago
SourceMandateNotification.php
2 years ago
SourceTransaction.php
2 years ago
Stripe.php
1 year ago
StripeClient.php
1 year ago
StripeClientInterface.php
2 years ago
StripeObject.php
1 year ago
StripeStreamingClientInterface.php
2 years ago
Subscription.php
1 year ago
SubscriptionItem.php
1 year ago
SubscriptionSchedule.php
1 year ago
TaxCode.php
1 year ago
TaxDeductedAtSource.php
2 years ago
TaxId.php
1 year ago
TaxRate.php
1 year ago
ThinEvent.php
1 year ago
Token.php
1 year ago
Topup.php
1 year ago
Transfer.php
1 year ago
TransferReversal.php
1 year ago
UsageRecord.php
1 year ago
UsageRecordSummary.php
1 year ago
Webhook.php
1 year ago
WebhookEndpoint.php
1 year ago
WebhookSignature.php
2 years ago
TaxId.php
201 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace WPForms\Vendor\Stripe; |
| 5 | |
| 6 | /** |
| 7 | * You can add one or multiple tax IDs to a <a href="https://stripe.com/docs/api/customers">customer</a> or account. |
| 8 | * Customer and account tax IDs get displayed on related invoices and credit notes. |
| 9 | * |
| 10 | * Related guides: <a href="https://stripe.com/docs/billing/taxes/tax-ids">Customer tax identification numbers</a>, <a href="https://stripe.com/docs/invoicing/connect#account-tax-ids">Account tax IDs</a> |
| 11 | * |
| 12 | * @property string $id Unique identifier for the object. |
| 13 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 14 | * @property null|string $country Two-letter ISO code representing the country of the tax ID. |
| 15 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 16 | * @property null|string|\Stripe\Customer $customer ID of the customer. |
| 17 | * @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. |
| 18 | * @property null|\Stripe\StripeObject $owner The account or customer the tax ID belongs to. |
| 19 | * @property string $type Type of the tax ID, one of <code>ad_nrt</code>, <code>ae_trn</code>, <code>al_tin</code>, <code>am_tin</code>, <code>ao_tin</code>, <code>ar_cuit</code>, <code>au_abn</code>, <code>au_arn</code>, <code>ba_tin</code>, <code>bb_tin</code>, <code>bg_uic</code>, <code>bh_vat</code>, <code>bo_tin</code>, <code>br_cnpj</code>, <code>br_cpf</code>, <code>bs_tin</code>, <code>by_tin</code>, <code>ca_bn</code>, <code>ca_gst_hst</code>, <code>ca_pst_bc</code>, <code>ca_pst_mb</code>, <code>ca_pst_sk</code>, <code>ca_qst</code>, <code>cd_nif</code>, <code>ch_uid</code>, <code>ch_vat</code>, <code>cl_tin</code>, <code>cn_tin</code>, <code>co_nit</code>, <code>cr_tin</code>, <code>de_stn</code>, <code>do_rcn</code>, <code>ec_ruc</code>, <code>eg_tin</code>, <code>es_cif</code>, <code>eu_oss_vat</code>, <code>eu_vat</code>, <code>gb_vat</code>, <code>ge_vat</code>, <code>gn_nif</code>, <code>hk_br</code>, <code>hr_oib</code>, <code>hu_tin</code>, <code>id_npwp</code>, <code>il_vat</code>, <code>in_gst</code>, <code>is_vat</code>, <code>jp_cn</code>, <code>jp_rn</code>, <code>jp_trn</code>, <code>ke_pin</code>, <code>kh_tin</code>, <code>kr_brn</code>, <code>kz_bin</code>, <code>li_uid</code>, <code>li_vat</code>, <code>ma_vat</code>, <code>md_vat</code>, <code>me_pib</code>, <code>mk_vat</code>, <code>mr_nif</code>, <code>mx_rfc</code>, <code>my_frp</code>, <code>my_itn</code>, <code>my_sst</code>, <code>ng_tin</code>, <code>no_vat</code>, <code>no_voec</code>, <code>np_pan</code>, <code>nz_gst</code>, <code>om_vat</code>, <code>pe_ruc</code>, <code>ph_tin</code>, <code>ro_tin</code>, <code>rs_pib</code>, <code>ru_inn</code>, <code>ru_kpp</code>, <code>sa_vat</code>, <code>sg_gst</code>, <code>sg_uen</code>, <code>si_tin</code>, <code>sn_ninea</code>, <code>sr_fin</code>, <code>sv_nit</code>, <code>th_vat</code>, <code>tj_tin</code>, <code>tr_tin</code>, <code>tw_vat</code>, <code>tz_vat</code>, <code>ua_vat</code>, <code>ug_tin</code>, <code>us_ein</code>, <code>uy_ruc</code>, <code>uz_tin</code>, <code>uz_vat</code>, <code>ve_rif</code>, <code>vn_tin</code>, <code>za_vat</code>, <code>zm_tin</code>, or <code>zw_tin</code>. Note that some legacy tax IDs have type <code>unknown</code> |
| 20 | * @property string $value Value of the tax ID. |
| 21 | * @property null|\Stripe\StripeObject $verification Tax ID verification information. |
| 22 | */ |
| 23 | class TaxId extends ApiResource |
| 24 | { |
| 25 | const OBJECT_NAME = 'tax_id'; |
| 26 | const TYPE_AD_NRT = 'ad_nrt'; |
| 27 | const TYPE_AE_TRN = 'ae_trn'; |
| 28 | const TYPE_AL_TIN = 'al_tin'; |
| 29 | const TYPE_AM_TIN = 'am_tin'; |
| 30 | const TYPE_AO_TIN = 'ao_tin'; |
| 31 | const TYPE_AR_CUIT = 'ar_cuit'; |
| 32 | const TYPE_AU_ABN = 'au_abn'; |
| 33 | const TYPE_AU_ARN = 'au_arn'; |
| 34 | const TYPE_BA_TIN = 'ba_tin'; |
| 35 | const TYPE_BB_TIN = 'bb_tin'; |
| 36 | const TYPE_BG_UIC = 'bg_uic'; |
| 37 | const TYPE_BH_VAT = 'bh_vat'; |
| 38 | const TYPE_BO_TIN = 'bo_tin'; |
| 39 | const TYPE_BR_CNPJ = 'br_cnpj'; |
| 40 | const TYPE_BR_CPF = 'br_cpf'; |
| 41 | const TYPE_BS_TIN = 'bs_tin'; |
| 42 | const TYPE_BY_TIN = 'by_tin'; |
| 43 | const TYPE_CA_BN = 'ca_bn'; |
| 44 | const TYPE_CA_GST_HST = 'ca_gst_hst'; |
| 45 | const TYPE_CA_PST_BC = 'ca_pst_bc'; |
| 46 | const TYPE_CA_PST_MB = 'ca_pst_mb'; |
| 47 | const TYPE_CA_PST_SK = 'ca_pst_sk'; |
| 48 | const TYPE_CA_QST = 'ca_qst'; |
| 49 | const TYPE_CD_NIF = 'cd_nif'; |
| 50 | const TYPE_CH_UID = 'ch_uid'; |
| 51 | const TYPE_CH_VAT = 'ch_vat'; |
| 52 | const TYPE_CL_TIN = 'cl_tin'; |
| 53 | const TYPE_CN_TIN = 'cn_tin'; |
| 54 | const TYPE_CO_NIT = 'co_nit'; |
| 55 | const TYPE_CR_TIN = 'cr_tin'; |
| 56 | const TYPE_DE_STN = 'de_stn'; |
| 57 | const TYPE_DO_RCN = 'do_rcn'; |
| 58 | const TYPE_EC_RUC = 'ec_ruc'; |
| 59 | const TYPE_EG_TIN = 'eg_tin'; |
| 60 | const TYPE_ES_CIF = 'es_cif'; |
| 61 | const TYPE_EU_OSS_VAT = 'eu_oss_vat'; |
| 62 | const TYPE_EU_VAT = 'eu_vat'; |
| 63 | const TYPE_GB_VAT = 'gb_vat'; |
| 64 | const TYPE_GE_VAT = 'ge_vat'; |
| 65 | const TYPE_GN_NIF = 'gn_nif'; |
| 66 | const TYPE_HK_BR = 'hk_br'; |
| 67 | const TYPE_HR_OIB = 'hr_oib'; |
| 68 | const TYPE_HU_TIN = 'hu_tin'; |
| 69 | const TYPE_ID_NPWP = 'id_npwp'; |
| 70 | const TYPE_IL_VAT = 'il_vat'; |
| 71 | const TYPE_IN_GST = 'in_gst'; |
| 72 | const TYPE_IS_VAT = 'is_vat'; |
| 73 | const TYPE_JP_CN = 'jp_cn'; |
| 74 | const TYPE_JP_RN = 'jp_rn'; |
| 75 | const TYPE_JP_TRN = 'jp_trn'; |
| 76 | const TYPE_KE_PIN = 'ke_pin'; |
| 77 | const TYPE_KH_TIN = 'kh_tin'; |
| 78 | const TYPE_KR_BRN = 'kr_brn'; |
| 79 | const TYPE_KZ_BIN = 'kz_bin'; |
| 80 | const TYPE_LI_UID = 'li_uid'; |
| 81 | const TYPE_LI_VAT = 'li_vat'; |
| 82 | const TYPE_MA_VAT = 'ma_vat'; |
| 83 | const TYPE_MD_VAT = 'md_vat'; |
| 84 | const TYPE_ME_PIB = 'me_pib'; |
| 85 | const TYPE_MK_VAT = 'mk_vat'; |
| 86 | const TYPE_MR_NIF = 'mr_nif'; |
| 87 | const TYPE_MX_RFC = 'mx_rfc'; |
| 88 | const TYPE_MY_FRP = 'my_frp'; |
| 89 | const TYPE_MY_ITN = 'my_itn'; |
| 90 | const TYPE_MY_SST = 'my_sst'; |
| 91 | const TYPE_NG_TIN = 'ng_tin'; |
| 92 | const TYPE_NO_VAT = 'no_vat'; |
| 93 | const TYPE_NO_VOEC = 'no_voec'; |
| 94 | const TYPE_NP_PAN = 'np_pan'; |
| 95 | const TYPE_NZ_GST = 'nz_gst'; |
| 96 | const TYPE_OM_VAT = 'om_vat'; |
| 97 | const TYPE_PE_RUC = 'pe_ruc'; |
| 98 | const TYPE_PH_TIN = 'ph_tin'; |
| 99 | const TYPE_RO_TIN = 'ro_tin'; |
| 100 | const TYPE_RS_PIB = 'rs_pib'; |
| 101 | const TYPE_RU_INN = 'ru_inn'; |
| 102 | const TYPE_RU_KPP = 'ru_kpp'; |
| 103 | const TYPE_SA_VAT = 'sa_vat'; |
| 104 | const TYPE_SG_GST = 'sg_gst'; |
| 105 | const TYPE_SG_UEN = 'sg_uen'; |
| 106 | const TYPE_SI_TIN = 'si_tin'; |
| 107 | const TYPE_SN_NINEA = 'sn_ninea'; |
| 108 | const TYPE_SR_FIN = 'sr_fin'; |
| 109 | const TYPE_SV_NIT = 'sv_nit'; |
| 110 | const TYPE_TH_VAT = 'th_vat'; |
| 111 | const TYPE_TJ_TIN = 'tj_tin'; |
| 112 | const TYPE_TR_TIN = 'tr_tin'; |
| 113 | const TYPE_TW_VAT = 'tw_vat'; |
| 114 | const TYPE_TZ_VAT = 'tz_vat'; |
| 115 | const TYPE_UA_VAT = 'ua_vat'; |
| 116 | const TYPE_UG_TIN = 'ug_tin'; |
| 117 | const TYPE_UNKNOWN = 'unknown'; |
| 118 | const TYPE_US_EIN = 'us_ein'; |
| 119 | const TYPE_UY_RUC = 'uy_ruc'; |
| 120 | const TYPE_UZ_TIN = 'uz_tin'; |
| 121 | const TYPE_UZ_VAT = 'uz_vat'; |
| 122 | const TYPE_VE_RIF = 've_rif'; |
| 123 | const TYPE_VN_TIN = 'vn_tin'; |
| 124 | const TYPE_ZA_VAT = 'za_vat'; |
| 125 | const TYPE_ZM_TIN = 'zm_tin'; |
| 126 | const TYPE_ZW_TIN = 'zw_tin'; |
| 127 | /** |
| 128 | * Creates a new account or customer <code>tax_id</code> object. |
| 129 | * |
| 130 | * @param null|array $params |
| 131 | * @param null|array|string $options |
| 132 | * |
| 133 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 134 | * |
| 135 | * @return \Stripe\TaxId the created resource |
| 136 | */ |
| 137 | public static function create($params = null, $options = null) |
| 138 | { |
| 139 | self::_validateParams($params); |
| 140 | $url = static::classUrl(); |
| 141 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 142 | $obj = \WPForms\Vendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 143 | $obj->setLastResponse($response); |
| 144 | return $obj; |
| 145 | } |
| 146 | /** |
| 147 | * Deletes an existing account or customer <code>tax_id</code> object. |
| 148 | * |
| 149 | * @param null|array $params |
| 150 | * @param null|array|string $opts |
| 151 | * |
| 152 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 153 | * |
| 154 | * @return \Stripe\TaxId the deleted resource |
| 155 | */ |
| 156 | public function delete($params = null, $opts = null) |
| 157 | { |
| 158 | self::_validateParams($params); |
| 159 | $url = $this->instanceUrl(); |
| 160 | list($response, $opts) = $this->_request('delete', $url, $params, $opts); |
| 161 | $this->refreshFrom($response, $opts); |
| 162 | return $this; |
| 163 | } |
| 164 | /** |
| 165 | * Returns a list of tax IDs. |
| 166 | * |
| 167 | * @param null|array $params |
| 168 | * @param null|array|string $opts |
| 169 | * |
| 170 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 171 | * |
| 172 | * @return \Stripe\Collection<\Stripe\TaxId> of ApiResources |
| 173 | */ |
| 174 | public static function all($params = null, $opts = null) |
| 175 | { |
| 176 | $url = static::classUrl(); |
| 177 | return static::_requestPage($url, \WPForms\Vendor\Stripe\Collection::class, $params, $opts); |
| 178 | } |
| 179 | /** |
| 180 | * Retrieves an account or customer <code>tax_id</code> object. |
| 181 | * |
| 182 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 183 | * @param null|array|string $opts |
| 184 | * |
| 185 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 186 | * |
| 187 | * @return \Stripe\TaxId |
| 188 | */ |
| 189 | public static function retrieve($id, $opts = null) |
| 190 | { |
| 191 | $opts = \WPForms\Vendor\Stripe\Util\RequestOptions::parse($opts); |
| 192 | $instance = new static($id, $opts); |
| 193 | $instance->refresh(); |
| 194 | return $instance; |
| 195 | } |
| 196 | const VERIFICATION_STATUS_PENDING = 'pending'; |
| 197 | const VERIFICATION_STATUS_UNAVAILABLE = 'unavailable'; |
| 198 | const VERIFICATION_STATUS_UNVERIFIED = 'unverified'; |
| 199 | const VERIFICATION_STATUS_VERIFIED = 'verified'; |
| 200 | } |
| 201 |