Update a payment link

PUT https://us-central1-appgregator.cloudfunctions.net/stripe/payment-links/:id/

Query Parameters

Name	Type	Description
name*	String	ft-4
connection_name*	String	stripe-1

Headers

Name	Type	Description
x-api-key*	String	XXX

Request Body

Name	Type	Description
active*	Boolean	false

200: OK

{
    "id": "plink_1MYiHfIyq0PiFIhUAC0GPXOU",
    "object": "payment_link",
    "active": false,
    "after_completion": {
        "hosted_confirmation": {
            "custom_message": null
        },
        "type": "hosted_confirmation"
    },
    "allow_promotion_codes": false,
    "application_fee_amount": null,
    "application_fee_percent": null,
    "automatic_tax": {
        "enabled": false
    },
    "billing_address_collection": "auto",
    "consent_collection": null,
    "currency": "usd",
    "custom_text": {
        "shipping_address": null,
        "submit": null
    },
    "customer_creation": "if_required",
    "invoice_creation": {
        "enabled": false,
        "invoice_data": {
            "account_tax_ids": null,
            "custom_fields": null,
            "description": null,
            "footer": null,
            "metadata": {},
            "rendering_options": null
        }
    },
    "livemode": false,
    "metadata": {},
    "on_behalf_of": null,
    "payment_intent_data": null,
    "payment_method_collection": "always",
    "payment_method_types": null,
    "phone_number_collection": {
        "enabled": false
    },
    "shipping_address_collection": null,
    "shipping_options": [],
    "submit_type": "auto",
    "subscription_data": {
        "description": null,
        "trial_period_days": null
    },
    "tax_id_collection": {
        "enabled": false
    },
    "transfer_data": null,
    "url": "https://buy.stripe.com/test_9AQ9BSbID59Hg3maEI"
}

cURL

curl --location --request PUT 'https://us-central1-appgregator.cloudfunctions.net/stripe/payment-links/plink_1MYiHfIyq0PiFIhUAC0GPXOU?name=ft-4&connection_name=stripe-1' \
--header 'x-api-key: XXX' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'active=false'

NodeJS - Axios

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
  'active': 'false' 
});
var config = {
  method: 'put',
  url: 'https://us-central1-appgregator.cloudfunctions.net/stripe/payment-links/plink_1MYiHfIyq0PiFIhUAC0GPXOU?name=ft-4&connection_name=stripe-1',
  headers: { 
    'x-api-key': 'XXX', 
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

PHP - cURL

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://us-central1-appgregator.cloudfunctions.net/stripe/payment-links/plink_1MYiHfIyq0PiFIhUAC0GPXOU?name=ft-4&connection_name=stripe-1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS => 'active=false',
  CURLOPT_HTTPHEADER => array(
    'x-api-key: XXX',
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;