Skip to content

Update a payment method without checks

Open .md

PATCH/v1/api/store/{team_slug}/setting/payment_method/{hash_id}

v1Operation ID v1_public_payment_method_update_patch

Use PUT to change this record. PATCH saves the same fields but skips validation, so a bad value can be stored or fail with a server error.

Permission

Needs the Manage Settings permission.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team
  • hash_idstringrequired

    The payment method's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

    • Example XbLngLA87AC5t5

Request body

application/json, required.

  • defaultboolean

    true makes it the team's default payment method. false does nothing.

  • namestring

Response

200Successful response.

  • dataobjectrequired
    Child fields (5)
    • created_atstring (date-time)required
    • defaultbooleanrequired

      Whether it is the team's default payment method.

    • idstringrequired
    • namestringrequired
    • trashedbooleanrequired

      True for a deleted payment method.

  • statusintegerrequired
  • successbooleanrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

    When
    The API key is missing or wrong.
    Fix
    Send your personal API key as Authorization: Bearer YOUR_API_KEY.
  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

    When
    Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.
    Fix
    Ask the team owner to give your permission group Manage Settings.
  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

    When
    No payment method with that id on this team (error.code is null and error.message starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both page_not_found).
    Fix
    Use an id from the list operation and check the team slug.