@@ -2727,7 +2727,15 @@ types:
27272727 maxLength: 96
27282728 billing_address:
27292729 type: optional<Address>
2730- docs: The billing address for this card.
2730+ docs: >-
2731+ The billing address for this card. `US` postal codes can be provided
2732+ as a 5-digit zip code
2733+
2734+ or 9-digit ZIP+4 (example: `12345-6789`). For a full list of field
2735+ meanings by country, see
2736+
2737+ [Working with
2738+ Addresses](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-addresses).
27312739 fingerprint:
27322740 type: optional<string>
27332741 docs: >-
@@ -2743,8 +2751,8 @@ types:
27432751 customer_id:
27442752 type: optional<nullable<string>>
27452753 docs: >-
2746- **Required** The ID of a customer created using the Customers API to
2747- be associated with the card.
2754+ **Required** The ID of a [ customer](entity:Customer) to be associated
2755+ with the card.
27482756 merchant_id:
27492757 type: optional<string>
27502758 docs: The ID of the merchant associated with the card.
@@ -2775,12 +2783,8 @@ types:
27752783 See [CardType](#type-cardtype) for possible values
27762784 prepaid_type:
27772785 type: optional<CardPrepaidType>
2778- docs: >-
2779- Indicates whether the Card is prepaid or not.
2780-
2781- The Card object includes this field only in response to Payments API
2782- calls.
2783-
2786+ docs: |-
2787+ Indicates whether the card is prepaid or not.
27842788 See [CardPrepaidType](#type-cardprepaidtype) for possible values
27852789 bin:
27862790 type: optional<string>
@@ -2811,6 +2815,41 @@ types:
28112815 co-brand of AFTERPAY.
28122816
28132817 See [CardCoBrand](#type-cardcobrand) for possible values
2818+ issuer_alert:
2819+ type: optional<CardIssuerAlert>
2820+ docs: >-
2821+ An alert from the issuing bank about the card status. Alerts can
2822+ indicate whether
2823+
2824+ future charges to the card are likely to fail. For more information,
2825+ see
2826+
2827+ [Manage Card on File
2828+ Declines](https://developer.squareup.com/docs/cards-api/manage-card-on-file-declines).
2829+
2830+
2831+ This field is present only if there's an active issuer alert.
2832+
2833+ See [IssuerAlert](#type-issueralert) for possible values
2834+ issuer_alert_at:
2835+ type: optional<string>
2836+ docs: >-
2837+ The timestamp of when the current issuer alert was received and
2838+ processed, in
2839+
2840+ RFC 3339 format.
2841+
2842+
2843+ This field is present only if there's an active issuer alert.
2844+ access: read-only
2845+ hsa_fsa:
2846+ type: optional<boolean>
2847+ docs: >-
2848+ Indicates whether the card is linked to a Health Savings Account (HSA)
2849+ or Flexible
2850+
2851+ Spending Account (FSA), based on the card BIN.
2852+ access: read-only
28142853 source:
28152854 openapi: openapi/openapi.json
28162855 CardBrand:
@@ -2840,6 +2879,9 @@ types:
28402879 docs: Indicates the brand for a co-branded card.
28412880 source:
28422881 openapi: openapi/openapi.json
2882+ CardIssuerAlert:
2883+ type: literal<"ISSUER_ALERT_CARD_CLOSED">
2884+ docs: Indicates the type of issuer alert for a [card on file](entity:Card).
28432885 CardPaymentDetails:
28442886 docs: >-
28452887 Reflects the current status of a card payment. Contains only
@@ -10546,6 +10588,7 @@ types:
1054610588 - SOURCE_EXPIRED
1054710589 - UNSUPPORTED_LOYALTY_REWARD_TIER
1054810590 - LOCATION_MISMATCH
10591+ - ORDER_UNPAID_NOT_RETURNABLE
1054910592 - IDEMPOTENCY_KEY_REUSED
1055010593 - UNEXPECTED_VALUE
1055110594 - SANDBOX_NOT_SUPPORTED
@@ -13554,6 +13597,15 @@ types:
1355413597 [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment)
1355513598 endpoints.
1355613599 access: read-only
13600+ creator_team_member_id:
13601+ type: optional<string>
13602+ docs: >-
13603+ The ID of the [team member](entity:TeamMember) who created the
13604+ invoice.
13605+
13606+ This field is present only on invoices created in the Square Dashboard
13607+ or Square Invoices app by a logged-in team member.
13608+ access: read-only
1355713609 source:
1355813610 openapi: openapi/openapi.json
1355913611 InvoiceAcceptedPaymentMethods:
@@ -16156,6 +16208,8 @@ types:
1615616208 reason:
1615716209 type: optional<nullable<string>>
1615816210 docs: The reason for the adjustment of points.
16211+ validation:
16212+ maxLength: 3500
1615916213 source:
1616016214 openapi: openapi/openapi.json
1616116215 LoyaltyEventCreateReward:
@@ -17506,50 +17560,62 @@ types:
1750617560 source:
1750717561 openapi: openapi/openapi.json
1750817562 ObtainTokenResponse:
17563+ docs: Represents an [ObtainToken](api-endpoint:OAuth-ObtainToken) response.
1750917564 properties:
1751017565 access_token:
1751117566 type: optional<string>
1751217567 docs: >-
17513- A valid OAuth access token.
17568+ An OAuth access token used to authorize Square API requests on behalf
17569+ of the seller.
17570+
17571+ Include this token as a bearer token in the `Authorization` header of
17572+ your API requests.
1751417573
17515- Provide the access token in a header with every request to Connect API
1751617574
17517- endpoints. For more information, see [OAuth API:
17575+ OAuth access tokens expire in 30 days (except `short_lived` access
17576+ tokens). You should call
17577+
17578+ `ObtainToken` and provide the returned `refresh_token` to get a new
17579+ access token well before
17580+
17581+ the current one expires. For more information, see [OAuth API:
1751817582 Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).
1751917583 validation:
1752017584 minLength: 2
1752117585 maxLength: 1024
1752217586 token_type:
1752317587 type: optional<string>
17524- docs: This value is always _bearer_ .
17588+ docs: The type of access token. This value is always `bearer` .
1752517589 validation:
1752617590 minLength: 2
1752717591 maxLength: 10
1752817592 expires_at:
1752917593 type: optional<string>
1753017594 docs: >-
17531- The date when the `access_token` expires, in [ISO
17595+ The timestamp of when the `access_token` expires, in [ISO
1753217596 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
1753317597 validation:
1753417598 minLength: 20
1753517599 maxLength: 48
1753617600 merchant_id:
1753717601 type: optional<string>
17538- docs: The ID of the authorizing merchant's business.
17602+ docs: >-
17603+ The ID of the authorizing [merchant](entity:Merchant) (seller), which
17604+ represents a business.
1753917605 validation:
1754017606 minLength: 8
1754117607 maxLength: 191
1754217608 subscription_id:
1754317609 type: optional<string>
1754417610 docs: >-
17545- __LEGACY FIELD__. The ID of a subscription plan the merchant signed up
17611+ __LEGACY__ The ID of merchant's subscription.
1754617612
17547- for. The ID is only present if the merchant signed up for a
17548- subscription plan during authorization.
17613+ The ID is only present if the merchant signed up for a subscription
17614+ plan during authorization.
1754917615 plan_id:
1755017616 type: optional<string>
1755117617 docs: >-
17552- __LEGACY FIELD__. The ID of the subscription plan the merchant signed
17618+ __LEGACY__ The ID of the subscription plan the merchant signed
1755317619
1755417620 up for. The ID is only present if the merchant signed up for a
1755517621 subscription plan during
@@ -17558,14 +17624,40 @@ types:
1755817624 id_token:
1755917625 type: optional<string>
1756017626 docs: >-
17561- The OpenID token belonging to this person. This token is only present
17562- if the
17627+ The OpenID token that belongs to this person. This token is only
17628+ present if the
17629+
17630+ `OPENID` scope is included in the authorization request.
17631+
17632+
17633+ Deprecated at version 2021-09-15. Square doesn't support OpenID or
17634+ other single sign-on (SSO)
1756317635
17564- OPENID scope is included in the authorization request .
17636+ protocols on top of OAuth .
1756517637 refresh_token:
1756617638 type: optional<string>
1756717639 docs: >-
17568- A refresh token.
17640+ A refresh token that can be used in an `ObtainToken` request to
17641+ generate a new access token.
17642+
17643+
17644+ With the code flow:
17645+
17646+ - For the `authorization_code` grant type, the refresh token is
17647+ multi-use and never expires.
17648+
17649+ - For the `refresh_token` grant type, the response returns the same
17650+ refresh token.
17651+
17652+
17653+ With the PKCE flow:
17654+
17655+ - For the `authorization_code` grant type, the refresh token is
17656+ single-use and expires in 90 days.
17657+
17658+ - For the `refresh_token` grant type, the refresh token is a new
17659+ single-use refresh token that expires in 90 days.
17660+
1756917661
1757017662 For more information, see [Refresh, Revoke, and Limit the Scope of
1757117663 OAuth
@@ -17576,19 +17668,23 @@ types:
1757617668 short_lived:
1757717669 type: optional<boolean>
1757817670 docs: >-
17579- A Boolean indicating that the access token is a short- lived access
17580- token.
17671+ Indicates whether the access_token is short lived. If `true`, the
17672+ access token expires
1758117673
17582- The short-lived access token returned in the response expires in 24
17583- hours.
17674+ in 24 hours. If `false`, the access token expires in 30 days.
1758417675 errors:
1758517676 type: optional<list<Error>>
1758617677 docs: Any errors that occurred during the request.
1758717678 refresh_token_expires_at:
1758817679 type: optional<string>
1758917680 docs: >-
17590- The date when the `refresh_token` expires, in [ISO
17591- 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
17681+ The timestamp of when the `refresh_token` expires, in [ISO
17682+ 8601](http://www.iso.org/iso/home/standards/iso8601.htm)
17683+
17684+ format.
17685+
17686+
17687+ This field is only returned for the PKCE flow.
1759217688 validation:
1759317689 minLength: 20
1759417690 maxLength: 48
0 commit comments